Skip to navigation

Invite Team Member

Email an invite to join the workspace. A pending invite takes a seat, so this is refused once members and invites reach the plan's team limit.

Headers

xi-api-keystringOptional
xi-workspace-idstring or nullOptional
The customer workspace a reseller's API key acts on.

Request

This endpoint expects an object.
emailstringRequired1-254 characters
roleenumOptionalDefaults to workspace_member
Allowed values:

Response

Successful Response

Errors

422
Unprocessable Entity Error