Skip to main content
PATCH
cURL
Renames a user group, or adds and removes members. A new name must not be used by another user group. Users are identified by the id returned by the list users endpoint.
  • All user identifiers are checked first: if one is not found, nothing is changed.
  • Guests cannot be in user groups and are skipped.
  • Removing a user who is not in the group does nothing.

Authorizations

X-Claap-Key
string
header
required

Path Parameters

userGroupId
string
required

User group identifier

Body

application/json
name
string

New user group name. It must not be used by another user group of the workspace.

Required string length: 1 - 100
addUserIds
string[]

Identifiers of the users to add to the group. Guests cannot be in groups and are skipped.

Maximum array length: 50
removeUserIds
string[]

Identifiers of the users to remove from the group.

Maximum array length: 50

Response

User group was successfully updated

result
object
required