Clerk API (unofficial showcase)
POST/waitlist_entries/bulk

Create multiple waitlist entries

Creates multiple waitlist entries from email addresses in a single request. Each entry requires email_address; notify defaults to true when omitted. You can submit 1 to 50 entries per request, but duplicate email addresses within the request are not allowed, and existing waitlist entries are returned without creating new entries.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

An array of 1 to 50 waitlist entry objects. Each entry requires an email address; duplicate addresses within the request are not allowed.

email_addressstringrequired
The email address to add to the waitlist
notifybooleanoptional
Optional flag which denotes whether a confirmation email should be sent to the given email address. Defaults to `true`.
Default:true

3 status codes
200Returns an array of waitlist entry objects, including their IDs, email addresses, statuses, and creation and update timestamps. Existing entries are returned without creating a new entry.
objectstringrequired
Allowed:waitlist_entry
idstringrequired
email_addressstringrequired
statusstringrequired
Allowed:pendinginvitedrejectedcompleted
is_lockedbooleanoptional
Indicates if the waitlist entry is locked. Locked entries are being processed in a batch action and are unavailable for other actions.
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.
invitationobjectoptional
400Returned when the request is unsuccessful.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Returned when request parameters are invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned when the request is unsuccessful; a 422 is returned for invalid request parameters. The request must contain 1 to 50 entries, each with a valid email_address; duplicate email addresses within the request are not allowed.