Edit a group

Updates existent group properties.

Required scopes: WORKSPACE

Resource URL

PATCH /workspaces/:domain/groups/:group_id

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
group_id
Required
IntegerThe numerical ID of the desired group.

POST Parameters

NameTypeDescription
descriptionStringThe description of the group.
nameStringThe name of the group.

Example

Request

PATCH https://api.buddy.works/workspaces/buddy/groups/1

JSON

{
  "description": "Developers"
}

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

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