Waitlists

Create a waitlist

Creates a waitlist and publishes it at /w/{slug} immediately. Omit reactCode to get the default template and iterate with updateWaitlist.

post/api/v1/waitlists

Request

  • Base URL: https://usewait.com
  • URL: https://usewait.com/api/v1/waitlists
  • Auth: HTTP bearer

Request body

namestring required
slugstring

Lowercase letters, digits and hyphens. Generated from the name when omitted.

descriptionstring
reactCodestring

The page itself: a single function GeneratedWaitlist(props) built with React.createElement (no JSX), rendered in a sandbox with React in scope. Call props.onSubmit({ email, name }) to submit a signup. Omit to get the default template.

seoTitlestring
seoDescriptionstring
seoKeywordsstring
ogImagestring uri

Social preview image. Use a PNG or JPG at 1200x630; SVG is rejected here.

referralEnabledboolean
referralBoostinteger
referralMessagestring

Response

The created waitlist.

Changes

No recorded changes to this operation across all 1 revision of this API.