POST/waitlist_entries/{waitlist_entry_id}/reject

Reject a waitlist entry

Rejects a waitlist entry and returns the resulting entry. Use the waitlist_entry_id path parameter to identify the entry to reject. Entries locked while a batch action is processing are unavailable for other actions.

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

1 parameter
waitlist_entry_idstringrequired
The ID of the waitlist entry to reject.

5 status codes
200Returns the waitlist entry, including its ID, email address, status, and creation and update timestamps.
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
404Returned when the waitlist entry is not found.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
409Returned when the rejection conflicts with the entry's current state.
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 404 when the waitlist entry is not found, and a 409 when the rejection conflicts with the entry's state. A 422 is returned for invalid request parameters. The waitlist_entry_id path parameter must identify the waitlist entry to reject.