createBulk()

1. WaitlistEntryBulkCreateParams
2. Usage
3. Backend API (BAPI) endpoint

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

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