Invite workspace members

Email the workspace invitation link to up to 20 addresses. Only the workspace owner can invite members. Addresses that already belong to members are skipped.


POST/api/v1/workspaces/{workspaceId}/invitations

Authorization

Authorization required string · header
Send Bearer <token> with an account API key that has the members:write scope.

Path parameters

workspaceId required string
Workspace ID. See TeamModel.

Request body

application/json

emails required string[]
1–20 email addresses. Invitees join the workspace when they follow the link in the email.

Response

201 · application/json

FieldTypeDescription
workspaceIdstringWorkspace ID.
emailsstring[]Lowercased addresses that were sent an invitation.