Skip to main content
POST
Send invitation

Path Parameters

workspaceSlug
string
required

URL-safe workspace identifier.

Body

application/json

Request payload for creating a new workspace invite.

Request payload for creating a new workspace invite.

expiresIn
required

When the invitation expires.

Allowed value: "in24Hours"
invitedRole
required

Role the invitee will have if they accept the invitation.

Allowed value: "owner"
inviteeEmail
string<email>
required

Email address of the person to invite.

Required string length: 5 - 254

Response

Acknowledgement returned after sending a workspace invitation.

The response is deliberately uniform: it carries no invite identifier or status, so it is identical whether or not the address belonged to a known account and cannot be used to probe for account existence.

Acknowledgement returned after sending a workspace invitation.

The response is deliberately uniform: it carries no invite identifier or status, so it is identical whether or not the address belonged to a known account and cannot be used to probe for account existence.

detail
string
required

Human-readable confirmation message.