API Reference

Confirmed

Signup succeeded. Use the returned position and referral link on your thank-you page.

{
  "success": true,
  "type": "confirmed",
  "position": 42,
  "referralCode": "abc123defg",
  "referralLink": "https://getwaitly.com/ref/abc123defg",
  "unsubscribeToken": "550e8400-..."
}

Pending confirmation

Email verification required. The visitor must click the link we email them before they count as confirmed.

{
  "success": true,
  "type": "pending_confirmation",
  "email": "visitor@example.com"
}

Blocked

The signup was accepted but fraud rules flagged it. Prevented from counting toward referrals or the public waitlist total.

{
  "success": true,
  "type": "confirmed",
  "position": 1,
  "referralCode": "",
  "referralLink": null,
  "unsubscribeToken": ""
}

Error

The signup was rejected. Check the error message for the reason.

{
  "success": false,
  "error": "You're already on this waitlist."
}

cURL

curl -X POST https://getwaitly.com/api/join \
  -H "Content-Type: application/json" \
  -d '{
    "email": "visitor@example.com",
    "slug": "my-product",
    "name": "Alex",
    "source": "landing-page"
  }'

JavaScript (fetch)

const res = await fetch("https://getwaitly.com/api/join", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    email: "visitor@example.com",
    slug: "my-product",
    name: "Alex",
    source: "landing-page",
    ref: referralCode,
    referrer: document.referrer,
    utmSource: params.get("utm_source"),
    utmMedium: params.get("utm_medium"),
  }),
});

const data = await res.json();
if (data.success) {
  window.location.href = `/thank-you?token=${data.unsubscribeToken}`;
}

HTML form (your own site)

<form
  action="https://getwaitly.com/api/join"
  method="POST"
  onsubmit="handleSubmit(event)"
>
  <input type="hidden" name="slug" value="my-product" />
  <input type="hidden" name="source" value="landing-page" />
  <input type="email" name="email" required placeholder="Your email" />
  <input type="text" name="name" placeholder="Full name (optional)" />
  <button type="submit">Join the waitlist</button>
</form>

<script>
async function handleSubmit(e) {
  e.preventDefault();
  const form = e.target;
  const body = Object.fromEntries(new FormData(form));
  const res = await fetch("https://getwaitly.com/api/join", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(body),
  });
  const data = await res.json();
  if (data.success) {
    window.location.href = `/thanks?token=${data.unsubscribeToken}`;
  }
}
</script>