SupDesk API
PATCH/v1/waitlist/signups/{id}

Update a waitlist signup

Updates the status or date fields of a waitlist signup. Supply any fields you want to change; status can be waiting, invited, or joined, and the date fields use date-time values. The response contains the updated signup.

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

1 parameter · 3 body fields
idstringrequired
The identifier of the waitlist signup to update.

Waitlist signup fields to update; all listed fields can be omitted.

statusstringoptional
The signup status: waiting, invited, or joined.
Allowed:waitinginvitedjoined
invited_atstringoptional
The date and time the user was invited, in date-time format.
joined_atstringoptional
The date and time the user joined, in date-time format.

3 status codes
200Returns the updated waitlist signup in the `data` object.
dataobjectoptional
401Returned when the request is not authenticated.
errorobjectoptional
404Returned when the waitlist signup does not exist.
errorobjectoptional

Error handling

A 401 is returned when the request is not authenticated, and a 404 is returned when the signup does not exist. The id path parameter must identify an existing waitlist signup. In the body, status must be waiting, invited, or joined, and invited_at and joined_at must use date-time values.