User group

PATCH
/workspaces
/:workspace
/groups
/:group_id

Edits the properties of an existing group.

Request

REQUIRED SCOPES

WORKSPACE

URL PARAMETERS

workspacerequiredstring

The workspace name.

group_idrequiredinteger

The numerical ID of the desired group.

POST PARAMETERS

descriptionstring

The description of the group.

namestring

The name of the group.

Last modified on Jan 19, 2026

Group Members Group Member

Request example


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

Response

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"
}