Waitlist endpoints

Create signup

POST /api/waitlist - create a waitlist signup from your server.

Create a signup when your own backend owns the form or signup flow.

Request

POST /api/waitlist accepts JSON. Authenticate with X-Api-Key or Authorization: Bearer; the legacy apiKey body field is also accepted here, but headers are preferred.

Create a signup
curl --request POST "$WAITLYZE_URL/api/waitlist" \
  --header "Content-Type: application/json" \
  --header "X-Api-Key: $WAITLYZE_API_KEY" \
  --header "Idempotency-Key: $REQUEST_ID" \
  --data '{
    "waitlistId": "YOUR_WAITLIST_ID",
    "email": "person@example.com"
  }'

Idempotency-Key is optional, but recommended for safe retries. Add referralCode to credit a referrer and marketingConsent: true only after the visitor has opted in. If Turnstile is enabled for the waitlist, include the visitor's cf-turnstile-response token.

Response

A successful response includes the signup's position, verification state, referral link, and reward summary. A duplicate returns 409 with the existing signup position; an expired or mismatched key returns 401. See the full signup guide for payload fields, examples, rate limits, and error handling.

Keep the key on your server

Waitlist API keys are secrets. Never expose one in browser code, a mobile bundle, or a public repository. For browser-only forms, use the hosted page or embed.

On this page