`createBulk()`

Parameters
1. WaitlistEntryBulkCreateParams
Example
Backend API (BAPI) endpoint

Creates multiple WaitlistEntrys in bulk 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.

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

Parameters

createBulk() accepts the following parameters:

Name
params
Type
WaitlistEntryBulkCreateParams[]
Description
An array of objects, each representing a single waitlist entry.

`WaitlistEntryBulkCreateParams`

Name
emailAddress
Type
string
Description
The email address to add to the waitlist.
Name
notify?
Type
boolean
Description
Whether to send an email notification to the user. Defaults to false.

Example

Note

Using 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 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.

Last updated on Feb 16, 2026