Skip to main content
PATCH
cURL
Changes the role of a user, or suspends or reactivates them. Provide exactly one of role or state.
  • Changing the state resets the role of a member to Member, and their license to the default of the workspace, usually Basic.
  • The last admin of the workspace cannot be demoted or suspended.

Authorizations

X-Claap-Key
string
header
required

Path Parameters

userId
string
required

User identifier

Body

application/json
role
enum<string>

New role of the user. A guest given one of these roles becomes a member and gets the default license of the workspace, usually Basic.

Available options:
Member,
Admin,
Owner
state
enum<string>

Suspend or reactivate the user. Changing the state resets the role of a member to Member, and their license to the default of the workspace, usually Basic.

Available options:
Active,
Suspended

Response

User was successfully updated

result
object
required