v1

latestOpenAPI 3.1.02026-08-04156223229.6 KB
invites

Create Workspace Invite

Create a magic-link invite for a workspace. Returns the token.

post/workspaces/{workspace_id}/invites

Path parameters

workspace_idstring required

Request body

invitee_emailstring required
role'owner' | 'editor' | 'viewer' | 'commenter'
messagestring nullable
notify_peopleboolean

Response

Successful Response

idstring required
workspace_idstring required
invitee_emailstring required
role'owner' | 'editor' | 'viewer' | 'commenter' required
messagestring nullable required
tokenstring nullable required
expires_atstring date-time required
created_atstring date-time required
accepted_atstring date-time nullable required