Clerk API (unofficial showcase)
POST/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.

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

2 body fields
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
200A Waitlist 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
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 422 is returned: Invalid request parameters.