Skip to main content

createBulk()

Caution

This endpoint is limited to a maximum of 50 waitlist entries per call. If you need to create more waitlist entries, make multiple requests, but keep in mind that this endpoint is rate limited.

Creates multiple waitlist entries for the given email addresses. If an email address is already on the waitlist, no new entry will be created and the existing waitlist entry will be returned.

Returns an array of created or existing WaitlistEntry objects.

function createBulk(params: WaitlistEntryBulkCreateParams): Promise<WaitlistEntry[]>

WaitlistEntryBulkCreateParams

  • Name
    emailAddress
    Type
    string
    Description

    The email address to add to the waitlist.

  • Name
    notify?
    Type
    boolean
    Description

    Whether to notify the user that their email address has been added to the waitlist. Notifies the user if the emailAddress is an email address. Defaults to true.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

// Each object in the array represents a single waitlist entry
const params = [
  {
    emailAddress: 'user1@example.com',
  },
  {
    emailAddress: 'user2@example.com',
    notify: true,
  },
]

const response = await clerkClient.waitlistEntries.createBulk(params)

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub