User group

PATCH
/workspaces
/:domain
/groups
/:group_id

Edits the properties of an existing group.

Request

REQUIRED SCOPES

WORKSPACE

URL PARAMETERS

domainrequired string

The workspace domain.

group_idrequired integer

The numerical ID of the desired group.

POST PARAMETERS

descriptionstring

The description of the group.

namestring

The name of the group.

Last modified on Sep 25, 2024

Group Members Group Member

Example:

curl -X PATCH "https://api.buddy.works/workspaces/:domain/groups/:group_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Developers"
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/groups/1",
  "html_url": "https://app.buddy.works/buddy/group/1",
  "id": 1,
  "name": "Dev Team",
  "description": "Developers"
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999