Waitlists

Create, read, update, and delete waitlists over the REST API.

A waitlist is a hosted signup page. Creating one makes it live at https://usewait.com/w/<slug> immediately, rendered with the default template unless you provide your own page code.

Create a waitlist

curl -X POST https://usewait.com/api/v1/waitlists \
  -H "Authorization: Bearer uw_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Robotics",
    "slug": "acme-robotics",
    "description": "Autonomous robots for small warehouses",
    "seoTitle": "Acme Robotics: join the waitlist",
    "referralEnabled": true
  }'

Fields

PropType

namestring

Display name, 1-100 characters.

Typestring

slug?string

URL slug: lowercase letters, numbers, hyphens, 3-100 characters, unique. Auto-generated from the name when omitted.

Typestring

description?string

Internal description, max 500 characters.

Typestring

reactCode?string

Full page code. See the page code reference. Omit to use the default template.

Typestring

seoTitle?string

SEO title override, max 70 characters.

Typestring

seoDescription?string

Meta description, max 160 characters.

Typestring

seoKeywords?string

Comma-separated keywords, max 255 characters.

Typestring

ogImage?string

Open Graph image URL. Upload via the assets endpoint first.

Typestring

referralEnabled?boolean

Enable the viral referral system. Requires a plan with referrals.

Typeboolean

referralBoost?number

Positions moved up per successful referral, 1-100.

Typenumber

referralMessage?string

Message shown after signup, max 500 characters.

Typestring

The response is 201 with the created waitlist, including its public url.

List, read, update, delete

curl https://usewait.com/api/v1/waitlists \
  -H "Authorization: Bearer uw_live_YOUR_KEY"

curl https://usewait.com/api/v1/waitlists/acme-robotics \
  -H "Authorization: Bearer uw_live_YOUR_KEY"

curl -X PATCH https://usewait.com/api/v1/waitlists/acme-robotics \
  -H "Authorization: Bearer uw_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "seoDescription": "Join the early access list." }'

curl -X DELETE https://usewait.com/api/v1/waitlists/acme-robotics \
  -H "Authorization: Bearer uw_live_YOUR_KEY"

GET of a single waitlist includes the current reactCode; the list endpoint omits it.
PATCH accepts the same fields as create, all optional. Changing slug moves the public URL; the old slug returns 404 afterward.
DELETE removes the waitlist and all of its entries. Irreversible.