v1

latestOpenAPI 3.0.12026-08-0435481.5 MB

Organization invitations

Create organization invitation

Create an organization invitation and optionally send it via email. The tenant should have an email connector configured if you want to send the invitation via email at this point.

post/api/organization-invitations

Request body

inviterIdstring nullable

The ID of the user who is inviting the user to join the organization.

inviteestring email required

The email address of the user to invite to join the organization.

organizationIdstring required

The ID of the organization to invite the user to join.

expiresAtnumber required

The epoch time in milliseconds when the invitation expires.

organizationRoleIdsstring[]

The IDs of the organization roles to assign to the user when they accept the invitation.

Response

The organization invitation was created successfully.

tenantIdstring required

idstring required

inviterIdstring nullable required

inviteestring required

acceptedUserIdstring nullable required

organizationIdstring required

status'Pending' | 'Accepted' | 'Expired' | 'Revoked' required

createdAtnumber required

updatedAtnumber required

expiresAtnumber required