Invitations

Create an invitation

Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error.

post/invitations

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/invitations
  • Auth: HTTP bearer

Request body

email_addressstring required

The email address the invitation will be sent to

public_metadataobject

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

Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a custom flow and you're not using Clerk Hosted Pages or Clerk Components.

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

Success

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"
}

Changes

No recorded changes to this operation across all 49 revisions of this API.