API Reference

Add a person to a waitlist. If the email already exists, the existing signup data is returned without creating a duplicate.

Response (201):

{
  "email": "jane@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "referral_token": "f7a3b2c1",
  "position": 42,
  "referral_count": 0,
  "total_signups": 150,
  "created_at": "2025-03-15T10:30:00.000Z"
}

Get a signup's current position, referral count, and details. If the waitlist owner has "Hide position" enabled (Advanced+), the position and total_signups fields are omitted.

Response (200):

{
  "email": "jane@example.com",
  "first_name": "Jane",
  "referral_token": "f7a3b2c1",
  "position": 42,
  "referral_count": 5,
  "total_signups": 150,
  "created_at": "2025-03-15T10:30:00.000Z"
}

Verify a signup's email address using the verification token sent by email. Also supports GET with ?token=TOKEN as a query parameter for clickable email links.

Request Body:

{ "token": "a3b2c1d4e5f67890..." }

Response (200):

{ "verified": true, "message": "Email verified successfully" }

Get the public configuration needed to render a signup form — name, headline, field visibility, custom questions, and current signup count. Also increments the daily page view counter for analytics.

Response (200):

{
  "waitlist_id": "a1b2c3d4",
  "name": "Beta Access",
  "headline": "Join the Beta",
  "subheadline": "Be the first to try our new product",
  "hero_image_url": "https://example.com/hero.png",
  "name_field": "optional",
  "phone_field": "hidden",
  "signup_count": 150,
  "custom_questions": [
    {
      "id": "q1",
      "label": "What's your role?",
      "type": "dropdown",
      "required": true,
      "options": ["Founder", "Developer", "Designer", "Other"]
    }
  ],
  "hide_branding": false,
  "hide_position": false
}

Get the total number of signups on a waitlist. Returns null for count if the waitlist has 10 or fewer signups or if the owner has "Hide position" enabled.

Response (200):

{ "waitlist_id": "a1b2c3d4", "count": 150 }

Get the top referrers for a waitlist. Fully anonymized — returns only rank and referral count, never names or emails.

Response (200):

{
  "waitlist_id": "a1b2c3d4",
  "leaderboard": [
    {
      "rank": 1,
      "referral_count": 12
    }
  ]
}

Unsubscribe a signup from marketing emails (blasts). Requires an HMAC-SHA256 token for verification.

Request Body:

{ "email": "jane@example.com", "token": "hmac_token_here" }

Permanently delete a signup's data from the waitlist. Requires a separate HMAC-SHA256 delete token (different from the unsubscribe token).

Request Body:

{ "email": "jane@example.com", "token": "delete_token_here" }

Complete a reward action. Each action can only be completed once per user. Boosts the signup's position by the action's points value. Requires the signup's referral token as ?token= query parameter.

Response (200):

{
  "action_id": "follow-twitter",
  "points_earned": 3,
  "new_position": 12,
  "completed_at": "2025-03-15T10:30:00.000Z"
}

List all reward actions a signup has completed. Requires the signup's referral token as ?token= query parameter.

Response (200):

{
  "completed_actions": [
    { "action_id": "follow-twitter", "action_label": "Follow us on X", "points": 3, "completed_at": "2025-03-15T10:30:00.000Z" }
  ]
}

Get a hosted landing page with Open Graph meta tags and an embedded signup widget. Returns text/html, not JSON. Designed for social media sharing — crawlers see proper og:title, og:description, and og:image tags.

Create a new account. Generates an API key and starts a 7-day free trial. Password must be at least 8 characters.

Request Body:

{
  "email": "jane@example.com",
  "password": "securePassword123"
}

Response (201):

{
  "email": "jane@example.com",
  "api_key": "mew_live_abc123...",
  "subscription_tier": "pro",
  "subscription_status": "trialing"
}

Get the authenticated user's profile including subscription status.

Response (200):

{
  "email": "jane@example.com",
  "has_api_key": true,
  "subscription_tier": "basic",
  "subscription_status": "active",
  "trial_ends_at": "2025-03-22T10:30:00.000Z",
  "stripe_customer_id": "cus_abc123"
}

Permanently delete your account and all associated data — waitlists, signups, templates, domains, team members, and analytics. Cancels any active Stripe subscription. This action cannot be undone.

Response: 204 No Content

Generate a new API key and invalidate the old one. Requires Bearer token authentication — cannot be called with an API key (returns 403).

Response (200):

{ "api_key": "mew_live_new_key_here..." }

Verify the user's email address using a token sent via email. No authentication required — the 256-bit token is proof of ownership. Accepts email and token from the request body or query parameters.

Request Body:

{ "email": "jane@example.com", "token": "a3b2c1d4e5f67890..." }

Response (200):

{ "verified": true, "message": "Email verified successfully" }

Resend the email verification link. Rate limited to one link per 60 seconds, maximum 10 resends total.

Response (200):

{ "message": "Verification link sent" }

Create a Stripe Checkout session to subscribe to a plan. Redirect the user to the returned URL.

Response (200):

{ "url": "https://checkout.stripe.com/c/pay/..." }

Create a Stripe Customer Portal session for plan changes, payment method updates, and invoice history.

Response (200):

{ "url": "https://billing.stripe.com/p/session/..." }

Preview what a plan change would cost, including proration details. Used by the pricing page to show a confirmation dialog before switching plans.

Request Body:

{
  "tier": "pro",
  "interval": "monthly"
}

Start a 7-day free trial of the Pro plan. Can only be used once per account.

Cancel the current subscription. The subscription remains active until the end of the billing period.

Get the current subscription details including tier, status, billing interval, and renewal date.

Create a new waitlist with optional settings for the signup form.

Request Body:

{
  "name": "Beta Access",
  "settings": {
    "headline": "Join the Beta",
    "subheadline": "Be the first to try our new product",
    "hero_image_url": "https://example.com/hero.png",
    "name_field": "optional",
    "phone_field": "hidden",
    "hide_branding": false,
    "hide_position": false,
    "custom_questions": [],
    "webhook_url": "https://your-server.com/webhook",
    "slack_webhook_url": "https://hooks.slack.com/...",
    "discord_webhook_url": "https://discord.com/api/webhooks/...",
    "allowed_email_domains": [],
    "exclude_personal_emails": false
  }
}

Only name is required. All settings fields are optional.

Response (201):

{
  "waitlist_id": "a1b2c3d4",
  "name": "Beta Access",
  "signup_count": 0,
  "created_at": "2025-03-15T10:30:00.000Z"
}

List all waitlists owned by the authenticated user.

Response (200):

{
  "waitlists": [
    {
      "waitlist_id": "a1b2c3d4",
      "name": "Beta Access",
      "signup_count": 150,
      "created_at": "2025-03-15T10:30:00.000Z"
    }
  ]
}

Get a single waitlist with full details including all settings.

Partial update — only provided fields are changed. Supports updating name and any settings fields.

Request Body:

{
  "name": "Updated Name",
  "settings": { "headline": "New Headline" }
}

Delete a waitlist and its metadata. Individual signup records are retained but become inaccessible.

Response: 204 No Content

List all signups for a waitlist with pagination. Includes email, name, phone, position, referral count, UTM data, custom answers, and verification status.

Get waitlist statistics including total signups and referral stats.

Remove a signup from the waitlist. Position numbers for remaining signups stay stable.

Response: 204 No Content

Move a signup to a specific position in the waitlist.

Request Body:

{ "position": 1 }

Delete multiple signups in a single request. Maximum 100 emails per call.

Request Body:

{ "emails": ["alice@example.com", "bob@example.com"] }

Response (200):

{ "deleted": 2 }

Update positions for multiple signups in a single request. Maximum 100 updates per call.

Request Body:

{ "updates": [{ "email": "alice@example.com", "position": 1 }, { "email": "bob@example.com", "position": 2 }] }

Response (200):

{ "moved": 2 }

Import up to 10,000 signups from a JSON array. Deduplicates against existing signups.

Request Body:

{
  "signups": [
    { "email": "alice@example.com", "first_name": "Alice" },
    { "email": "bob@example.com", "first_name": "Bob", "phone": "+1234567890" }
  ]
}

Response (200):

{ "imported": 2, "skipped": 0, "errors": [] }

Create an invitation code. If no code is provided, a random 12-character hex code is generated. Codes must be 3–50 characters, alphanumeric with hyphens and underscores.

Request Body:

{ "code": "EARLY-ACCESS", "max_uses": 100 }

Response (201):

{ "code": "EARLY-ACCESS", "max_uses": 100, "uses": 0, "created_at": "2025-03-15T10:30:00.000Z" }

List all invitation codes for a waitlist with usage counts.

Delete an invitation code.

Response: 204 No Content

Create a new A/B test variant. The weight controls how often this variant is shown relative to others.

Request Body:

{
  "headline": "Join the Revolution",
  "subheadline": "Early adopters get exclusive perks",
  "hero_image_url": "https://example.com/hero-b.png",
  "weight": 50
}

Response (201):

{
  "variant_id": "a1b2c3d4-...",
  "headline": "Join the Revolution",
  "subheadline": "Early adopters get exclusive perks",
  "hero_image_url": "https://example.com/hero-b.png",
  "weight": 50,
  "views": 0,
  "signups": 0,
  "created_at": "2025-03-15T10:30:00.000Z"
}

List all variants with view/signup statistics and conversion rates.

Update a variant's headline, subheadline, hero image, or weight.

Delete an A/B test variant.

Response: 204 No Content

List available presets: viral-giveaway, product-launch, beta-access, referral-contest.

Create a new waitlist from a preset. Pre-configures settings and creates associated email templates.

Request Body:

{ "preset_id": "viral-giveaway", "name": "Summer Giveaway" }

Response (201):

{
  "waitlist_id": "a1b2c3d4-...",
  "name": "Summer Giveaway",
  "preset_id": "viral-giveaway",
  "preset_name": "Viral Giveaway",
  "templates_created": 2,
  "created_at": "2025-03-15T10:30:00.000Z"
}

Download all signups as a CSV file. Includes email, name, phone, position, referral count, UTM data, verification status, and timestamps. Supports ?token=YOUR_JWT query parameter as an alternative to the Authorization header (useful for browser download links).

Get daily traffic analytics — page views and signups over time.

Get UTM attribution data — breakdown of signups by source, medium, and campaign.

Send an email blast to all signups on a waitlist.

Request Body:

{
  "subject": "We're launching next week!",
  "html_body": "<h1>Big news!</h1><p>We're launching next Tuesday.</p>",
  "text_body": "Big news! We're launching next Tuesday."
}

List all email blasts sent to a waitlist with delivery stats.

Create a reusable email template. Supports HTML with placeholder variables like {{first_name}}, {{position}}, and {{waitlist_name}}.

Request Body:

{
  "template_type": "signup_confirmation",
  "name": "Welcome Email",
  "subject_template": "You're In, !",
  "html_body_template": "<h1>Welcome!</h1><p>Your position is #.</p>"
}

List all email templates.

Get a single template with full HTML body.

Update a template. Partial update — only provided fields are changed.

Delete an email template.

Response: 204 No Content

Start domain verification. Returns DNS records (DKIM, SPF) to add to your domain.

Request Body:

{ "domain": "mail.yourdomain.com" }

List all verified and pending domains.

Check the verification status and get the required DNS records.

Remove a verified domain.

Response: 204 No Content

Invite a team member by email.

Request Body:

{ "email": "teammate@example.com" }

List all team members with their email, role, and when they were added.

Remove a team member. They immediately lose access to your waitlists.

Response: 204 No Content

Receives Stripe webhook events for subscription lifecycle management. This endpoint is called by Stripe, not by your application.

Events handled:

• checkout.session.completed — new subscription created
• invoice.paid — subscription renewed or upgraded
• invoice.payment_failed — payment failed
• customer.subscription.updated — subscription plan changed via Customer Portal
• customer.subscription.deleted — subscription cancelled