Skip to main content
POST
Invite user to organization

Path Parameters

organizationId
string<uuid>
required

Organization identifier

Body

application/json
email
string<email>
required

Email of the person invited

role
enum<string>
required

Role to assign

Available options:
administrator,
manager,
billing_manager,
member
teamAssignments
object[]

Array of team assignments with roles for automatic addition upon invitation acceptance

Example:

Response

User invited to organization

id
string<uuid>
required

Invitation unique identifier

token
string
required

Invitation token

email
string
required

Email of the invitee

status
string
required

Current status of the invitation

organizationId
string<uuid>
required

Organization unique identifier

organizationName
string
required

Organization name

organizationRole
string
required

Role in the organization

expiresAt
string<date-time>
required

Invitation expiration date