Sign in
latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Organization Invitations

Invite user to an organization by email

Creates an invitation to an organization for a user with the specified email address.

post/organizations/{organization_id}/invitations

Request body

emailstring email required

The email address of the invitee.

permissionsstring[] required

The permissions the invitee should be given on the organization.

forceboolean

Whether to cancel any pending invitation for the specified invitee, and create a new invitation.

Response

Created

idstring uuid

The ID of the invitation.

state'pending' | 'processing' | 'accepted' | 'cancelled' | 'error'

The invitation state.

organization_idstring

The ID of the organization.

emailstring email

The email address of the invitee.

created_atstring date-time

The date and time when the invitation was created.

updated_atstring date-time

The date and time when the invitation was last updated.

finished_atstring date-time nullable

The date and time when the invitation was finished.

permissionsstring[]

The permissions the invitee should be given on the organization.