Skip to main content
Docs

createInvitationBulk()

Creates multiple Invitations in bulk for the given email addresses and sends the invitation emails.

If an email address has already been invited or already exists in your application, trying to create a new invitation will return an error. To bypass this error and create a new invitation anyways, set ignoreExisting to true.

function createInvitationBulk(params: CreateBulkParams): Promise<Invitation[]>

Parameters

  • Name
    params
    Type
    CreateBulkParams[]
    Description

    An array of objects, each representing a single invitation.

CreateBulkParams

  • Name
    emailAddress
    Type
    string
    Description

    The email address of the user to invite.

  • Name
    redirectUrl?
    Type
    string
    Description

    The full URL or path 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.

  • Name
    publicMetadata?
    Type
    Description

    Metadata that can be read from both the Frontend API and Backend API, but can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.

  • Name
    notify?
    Type
    boolean
    Description

    Whether an email invitation should be sent to the given email address. Defaults to true.

  • Name
    ignoreExisting?
    Type
    boolean
    Description

    Whether an invitation should be created if there is already an existing invitation for this email address, or if the email address already exists in the application. Defaults to false.

  • Name
    expiresInDays?
    Type
    number
    Description

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

  • Name
    templateSlug?
    Type
    'invitation' | 'waitlist_invitation'
    Description

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

Example

Note

Importing clerkClient varies based on your framework. Refer to the JS Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

// Each object in the array represents a single invitation
const params = [
  {
    emailAddress: 'invite@example.com',
    redirectUrl: 'https://www.example.com/my-sign-up',
    publicMetadata: {
      example: 'metadata',
      example_nested: {
        nested: 'metadata',
      },
    },
  },
  {
    emailAddress: 'invite2@example.com',
    redirectUrl: 'https://www.example.com/my-sign-up',
    publicMetadata: {
      example: 'metadata',
      example_nested: {
        nested: 'metadata',
      },
    },
  },
]

const response = await clerkClient.invitations.createInvitationBulk(params)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/invitations/bulk. See the BAPI reference for more information.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on