Create Invitation
Invite someone to a workspace by email.
Invites an email address to the workspace and sends the invitation email. The invitee doesn't need a Syntext account yet.
The response does not include the invitation token. The token is sent only to the invited address, because holding it is how the invitee proves they own that mailbox when they accept.
Requires the admin or owner role and a session JWT. API keys are rejected with 401. Any plan, but each plan caps the number of seats — see plan seat limit below — and a workspace can have at most 10 pending invitations at a time — see invite limit.
Path Parameters
orgIdRequest Body
emailroleadmin or member."member"expiresInDays7Response — 201 Created
The invitation is recorded in the audit log as org.invite.created. To send the email again, use Resend Invitation.
Error Responses
400 Bad Request
validation_error — an invalid email, unknown role or out-of-range expiresInDays. details.issues lists each problem — see Validation errors.
401 Unauthorized
unauthorized for a missing, invalid or expired token (or an API key); session_revoked when the session has been signed out.
402 Payment Required
USAGE_LIMIT_EXCEEDED — the plan's seat limit is reached, and no invitation is created. Seats are current members plus invitations that can still be accepted (pending and not expired) — declined, revoked and expired invitations don't hold a seat. Free allows 2, Starter 5, Pro 20, Enterprise unlimited. Adding a member directly applies the same limit.
403 Forbidden
forbidden — you are a member ("Only workspace admins can invite members.", with details.requiredRole: "admin" and details.currentRole), or you don't belong to the workspace ("Not a member of this organization").
404 Not Found
not_found ("Organization not found") — the workspace does not exist or has been deleted.
409 Conflict
invite_limit_reached — the workspace already has 10 pending invitations, and no invitation is created. Only invitations that can still be accepted count (pending and not expired); revoke one with Revoke Invitation, or wait for one to be accepted, declined or to expire. No plan raises this limit. When the seat limit is reached too, this error is returned rather than the 402. details.max is the limit and details.pending the current count.
To invite several people, send one request per address; each counts toward the limit as it is created.