SupDesk
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 address format; you can also include a referral_code. A 200 response indicates an existing signup was reused, while a 201 response contains a newly created signup.

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

2 body fields

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

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

3 status codes
200Returns the existing waitlist signup in the `data` object.
dataobjectoptional
201Returns the newly created waitlist signup in the `data` object.
dataobjectoptional
401Returned when the request has missing or invalid authentication credentials.
errorobjectoptional

Error handling

A 401 is returned when the request has missing or invalid authentication credentials. email is required and must use a valid email address format.