Sign in

v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
User Groups

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.

put/v2/group/{group_id}

Path parameters

group_idstring required
Example:C9C58BE9

User Group ID

Request body

namestring
handlestring

Example request

{
  "name": "New User Group Name",
  "handle": "newusergroupname",
  "members": {
    "add": [
      123456,
      987654
    ],
    "rem": [
      159753
    ]
  }
}

Response

idstring required
team_idstring required
useridinteger required
namestring required
handlestring required
date_createdstring required
initialsstring required

Example response

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