Waitlist Entries

Create a waitlist entry

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

post/waitlist_entries

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/waitlist_entries
  • Auth: HTTP bearer

Request body

email_addressstring required

The email address to add to the waitlist

notifyboolean nullable

Optional flag which denotes whether a confirmation email should be sent to the given email address. Defaults to true.

Response

A Waitlist Entry

object'waitlist_entry' required
idstring required
email_addressstring email required
status'pending' | 'invited' | 'rejected' | 'completed' required
is_lockedboolean

Indicates if the waitlist entry is locked. Locked entries are being processed in a batch action and are unavailable for other actions.

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Example response

{
  "status": "pending",
  "invitation": {
    "status": "pending"
  }
}

Changes

No recorded changes to this operation across all 49 revisions of this API.