Skip to main content
POST
Invite To Workspace

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Workspace-Id
string | null

Path Parameters

workspace_id
string<uuid> | null
required

Body

application/json
workspace_id
string<uuid4>
required
invitee_email
string<email>
required
team_id
string<uuid4> | null
expiry_time
string<date-time> | null
role
enum<integer>
default:1
Available options:
3,
2,
1,
0

Response

Successful Response

id
string<uuid4>
required
workspace_id
string<uuid4>
required
invitee_email
string<email>
required
invited_by
string<uuid4>
required
status
enum<string>
required
Available options:
pending,
accepted,
rejected,
expired
expiry_time
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
team_id
string<uuid4> | null