API Reference

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.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

User Group ID

Body Params

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.

string
string
object
Response

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json