Skip to main content
POST
Send Invitation
Sends an email invitation to join the organization with a specified role. The invitation expires after 7 days. Cannot send an invitation if the user is already a member or has a pending invitation. Requires the invitations:create permission.

Auth

Requires a valid Bearer token with invitations:create permission.

Path Parameters

string
required
Organization identifier.

Request Body

string
required
Email address to invite. Must be a valid email format.
string
required
Role to assign when the invitation is accepted. One of "admin", "member", or "viewer".

Response

object
The created invitation object with id, organizationId, email, role, invitedBy, expiresAt, createdAt, and status.
string
URL for the invitee to accept the invitation.

Errors

Example