v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Group API

Edits the properties of an existing group

patch/workspaces/{workspace_domain}/groups/{id}

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

idinteger required
Example:123

The ID of the group

Request body

namestring

The name of the group

descriptionstring

The description of the group

auto_assign_to_new_projectsboolean

Whether to automatically assign group members to new projects

allow_add_new_projectsboolean

Whether group members are allowed to add new projects

allow_add_new_domains_on_owner_behalfboolean

Whether group members are allowed to buy new domains on behalf of the workspace owner

auto_assign_permission_set_idinteger

The ID of the permission set to automatically assign to new project members

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

idinteger

The ID of the group

namestring

The name of the group

descriptionstring

The description of the group

auto_assign_to_new_projectsboolean

Whether to automatically assign group members to new projects

allow_add_new_projectsboolean

Whether group members are allowed to add new projects

allow_add_new_domains_on_owner_behalfboolean

Whether group members are allowed to buy new domains on behalf of the workspace owner

auto_assign_permission_set_idinteger

The ID of the permission set to automatically assign to new project members