Skip to main content
POST
Create Invitation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json
email
string | null

Address the invitation is for; omit for an open link anyone can accept

Maximum string length: 320
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
expires_in_days
integer | null
Required range: 1 <= x <= 365

Response

Successful Response

Same as InvitationResponse plus the plaintext token, returned ONCE.

accepted_at
string<date-time> | null
required
accepted_by_user_id
string | null
required
created_at
string<date-time>
required
email
string | null
required
email_delivery
enum<string>
required
Available options:
sent,
not_requested,
not_configured,
failed
expires_at
string<date-time>
required
id
string<uuid>
required
invited_by
string
required
invited_by_display_name
string | null
required
status
string
required
token
string
required
workspace_id
string
required