v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB

Organization Invitations

Create and send an organization invitation

Creates a new organization invitation and sends an email to the provided email_address with a link to accept the invitation and join the organization. You can specify the role for the invited organization member.

New organization invitations get a "pending" status until they are revoked by an organization administrator or accepted by the invitee.

The request body supports passing an optional redirect_url parameter. When the invited user clicks the link to accept the invitation, they will be redirected to the URL provided. Use this parameter to implement a custom invitation acceptance flow.

You can specify the ID of the user that will send the invitation with the inviter_user_id parameter. That user must be a member with administrator privileges in the organization. Only "admin" members can create organization invitations.

You can optionally provide public and private metadata for the organization invitation. The public metadata are visible by both the Frontend and the Backend whereas the private ones only by the Backend. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.

post/organizations/{organization_id}/invitations

Path parameters

organization_idstring required

The ID of the organization for which to send the invitation

Request body

email_addressstring required

The email address of the new member that is going to be invited to the organization

inviter_user_idstring nullable

The ID of the user that invites the new member to the organization. Must be an administrator in the organization.

rolestring required

The role of the new member in the organization

public_metadataobject nullable

Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.

private_metadataobject nullable

Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.

redirect_urlstring nullable

Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.

expires_in_daysinteger nullable

The number of days the invitation will be valid for. By default, the invitation has a 30 days expire.

notifyboolean nullable

Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to true.

Response

An organization invitation

object'organization_invitation' required

String representing the object's type. Objects of the same type share the same value.

idstring required

email_addressstring required

rolestring required

role_namestring required

organization_idstring

inviter_idstring nullable required

statusstring

public_metadataobject required

private_metadataobject

urlstring nullable required

expires_atinteger nullable required

Unix timestamp of expiration.

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.