Sign in

v5

OpenAPI 3.1.02026-08-043621,4011.8 MB
workspace

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.

post/v1/workspace/members

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

emailstring required

Email of the target user.

is_lockedboolean nullable

Whether to lock or unlock the user account.

workspace_role'workspace_admin' | 'workspace_member' | 'workspace_lite_member'

Seat types for workspace members.

workspace_seat_type'workspace_admin' | 'workspace_member' | 'workspace_lite_member'

Seat types for workspace members.

Response

Successful Response

statusstring required

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.

Example response

{
  "status": "ok"
}