Edit a group
Updates existent group properties.
Required scopes: WORKSPACE
Resource URL
PATCH /workspaces/:domain/groups/:group_id
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
group_id Required | Integer | The numerical ID of the desired group. |
POST Parameters
Name | Type | Description |
---|---|---|
description | String | The description of the group. |
name | String | The name of the group. |
Example
Request
PATCH https://api.buddy.works/workspaces/buddy/groups/1
JSON
{"description": "Developers"}
Sample Response
HTTP
Status: 200 OKX-Rate-Limit-Limit: 1X-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"}