Sign in
v1
protected
workspace-invitations

Create Invitation

Create an invitation link for the given workspace.

The plaintext token is returned exactly once in the response. The caller delivers it however they want (link, email, Slack).

post/v1/workspaces/{workspace}/invitations

Path parameters

workspacestring required

Slug of the workspace the request acts in

Slug of the workspace the request acts in

Request body

emailstring nullable
expires_in_daysinteger nullable

Response

Successful Response

accepted_atstring nullable required
accepted_by_user_idstring nullable required
created_atstring required
emailstring nullable required
email_delivery'sent' | 'not_requested' | 'not_configured' | 'failed' required
expires_atstring required
idstring uuid required
invited_bystring required
invited_by_display_namestring nullable required
statusstring required
tokenstring required
workspace_idstring required

Changes