Update Group
This endpoint is used to manage User Groups, which are groups of users within your Workspace.
In our API, team_id in the path refers to the Workspace ID, and group_id refers to the ID of a User Group.
Note: Adding a guest with view-only permissions to a User Group automatically converts them to a paid guest.
If you don't have any paid guest seats available, a new member seat is automatically added to increase the number of paid guest seats.
This incurs a prorated charge based on your billing cycle.
SecurityAuthorization_Token
Request
Request Body schema: application/jsonrequired
The group handle can be updated, which is used to @mention a User Group within the Workspace.
Modify Group members by using the "add" and "rem" parameters with an array of user IDs to include or exclude members.
Responses
200
put/v2/group/{group_id}
Request samples
- Payload
- curl
- C#
- JavaScript
- Java
- Java 8 with Apache
- Go
- Node.js
- PHP
- Python
- R
- Ruby
application/json
{- "name": "New User Group Name",
- "handle": "newusergroupname",
- "members": {
- "add": [
- 123456,
- 987654
], - "rem": [
- 159753
]
}
}Response samples
- 200
application/json
{- "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
- "team_id": "123456",
- "userid": 301828,
- "name": "New User Group Name",
- "handle": "newusergroupname",
- "date_created": "1640122639829",
- "initials": "NN",
- "members": [
- {
- "id": 201,
- "username": "Jim Halpert",
- "email": "jim@example.com",
- "color": "#40BC86",
- "initials": "JH",
- "profilePicture": null
}, - {
- "id": 202,
- "username": "Dwight Shrute",
- "email": "dwight@example.com",
- "color": "#FF8600",
- "initials": "DS",
- "profilePicture": null
}
], - "avatar": {
- "attachment_id": null,
- "color": null,
- "source": null,
- "icon": null
}
}