Edit
Edits the properties of an existing group.
Required scopes: WORKSPACE
Resource URL
PATCH /workspaces/:domain/groups/:group_idURL 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/1JSON
{
"description": "Developers"
}Sample Response
HTTP
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999JSON
{
"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"
}Group member
Updates the group member's status.
Required scopes: WORKSPACE
Resource URL
PATCH /workspaces/:domain/groups/:group_id/members/:member_idURL Parameters
| Name | Type | Description |
|---|---|---|
domain Required | String | The workspace domain. |
group_id Required | Integer | The numerical ID of the desired group. |
member_id Required | Integer | The numerical ID of the desired user. |
PATCH Parameters
| Name | Type | Description |
|---|---|---|
status Required | String | The group member status. Can be one of: MEMBER, MANAGER |
Example
Request
PATCH https://api.buddy.works/workspaces/buddy/groups/1/members/1JSON
{
"status": "MANAGER"
}Sample Response
HTTP
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999JSON
{
"url": "https://api.buddy.works/workspaces/buddy/groups/1/members/1",
"html_url": "https://app.buddy.works/buddy/profile/1",
"id": 1,
"name": "Mike Benson",
"avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
"admin": true,
"workspace_owner": true,
"status": "MANAGER"
}Last modified on July 26, 2022