Clerk API (unofficial showcase)
POST/waitlist_entries/{waitlist_entry_id}/invite

Invite a waitlist entry

Send an invite to the email address in a waitlist entry.

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

1 parameter · 1 body field
waitlist_entry_idstringrequired
The ID of the waitlist entry to invite
ignore_existingbooleanoptional
Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user.
Default:false

5 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
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
409Conflict
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 404 is returned: Resource not found. A 409 is returned: Conflict. A 422 is returned: Invalid request parameters.