SupDesk API
POST/v1/waitlist/signups

Create or reuse a waitlist signup

Creates a waitlist signup or reuses an existing signup for the supplied email address. Provide email in a valid email format; you can also include a referral_code. A 200 response returns the existing signup, while a 201 response returns the newly created signup.

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

2 body fields

The email address and optional referral code for the waitlist signup.

emailstringrequired
The signup email address in a valid email format.
referral_codestringoptional
The referral code associated with the signup.

3 status codes
200Returns the existing waitlist signup in the `data` field.
dataobjectoptional
201Returns the newly created waitlist signup in the `data` field.
dataobjectoptional
401Returned when the request is unauthenticated.
errorobjectoptional

Error handling

A 401 is returned when the request is unauthenticated. email is required and must use a valid email format.