Update member

Updates attributes of a workspace member. Apart from the email identifier, all parameters will remain unchanged unless specified. This endpoint may only be called by workspace administrators.

Headers

xi-api-keystringRequired

Request

This endpoint expects an object.
emailstringRequired
Email of the target user.
is_lockedboolean or nullOptional
Whether to lock or unlock the user account.
workspace_seat_typeenum or nullOptional
The workspace seat type
Allowed values:
workspace_roleenum or nullOptionalDeprecated

The workspace role of the user. This is deprecated, use workspace_seat_type instead.

Allowed values:

Response

Successful Response
statusstring
The status of the workspace member update request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.

Errors