Sign in

v13

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

Create multiple invitations

Use this API operation to create multiple invitations for the provided email addresses. You can choose to send the invitations as emails by setting the notify parameter to true. There cannot be an existing invitation for any of the email addresses you provide unless you set ignore_existing to true for specific email addresses. Please note that there must be no existing user for any of the email addresses you provide, and this rule cannot be bypassed.

This endpoint is limited to a maximum of 10 invitations per API call. If you need to send more invitations, please make multiple requests.

post/invitations/bulk

Request body

email_addressstring required

The email address the invitation will be sent to

public_metadataobject nullable

Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.

redirect_urlstring nullable

The URL where the user is redirected upon visiting the invitation link, where they can accept the invitation. Required if you have implemented a custom flow for handling application invitations.

notifyboolean nullable

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

ignore_existingboolean nullable

Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user.

expires_in_daysinteger nullable

The number of days the invitation will be valid for. By default, the invitation expires after 30 days.

template_slug'invitation' | 'waitlist_invitation'

The slug of the email template to use for the invitation email.

Response

List of invitations

object'invitation' required
idstring required
email_addressstring email required
public_metadataobject required
revokedboolean
status'pending' | 'accepted' | 'revoked' | 'expired' required
urlstring
expires_atinteger nullable

Unix timestamp of expiration.

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Example response

[
  {
    "status": "pending"
  }
]