Waitlist API reference

Waitlist API · Entries

post/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/{entry_id}/releaseAuth

Release a held entry from the review queue

For a sign-up the referral fraud checks held (`held`). It carries on as if the checks had passed: with email confirmation on it becomes `unconfirmed` and gets the confirmation email; otherwise `pending` or `approved`, its referrer gets credit, `entry.created` (and `entry.approved`) fire and the welcome email goes out. To turn it away instead, `PATCH` it to `rejected` (nothing is sent).

Path parameters

workspace_id*string · uuid

Id of the workspace.

waitlist_id*string · uuid

Id of the waitlist.

entry_id*string · uuid

Id of the entry.

Headers

Idempotency-Keystring

Idempotency key (24 h). A retry with the same key and body returns the first response instead of acting twice.

Response · 200 Released.

id*string · uuid

Entry id.

waitlist_id*string · uuid

The waitlist the entry is on.

workspace_id*string · uuid

The workspace that owns the waitlist.

email*string · email

Normalised (lower-cased) email.

name*string

Name given at sign-up.

interest*string

Free-text product interest from the sign-up; null when not given.

referrer*string

How they heard about it, from the sign-up; null when not given.

referral_code*string

This entry's referral code. Others pass it as `referral_code` on sign-up to credit this entry.

referral_count*integer

Number of honoured referrals.

referred_by_entry_id*string · uuid

The entry whose referral code this sign-up used; null when none.

position*integer

Place in the queue, from 1. Test entries have negative positions (-1, -2…) so they never take a real place.

is_test*boolean

Made with "Add test signup". Test entries use a mailbox-simulator address and are left out of counts, analytics, exports and webhooks unless asked.

Example: false

fraud_signals*array

Why the referral fraud checks held this entry (`held`); empty otherwise. Kept after release as a record.

status*object

`unconfirmed` waits for its owner to confirm their email (waitlists with `email_confirmation`) and does not count yet; `pending` waits for approval; `approved` and `rejected` are decided.

confirmed_at*string · date-time

When the owner confirmed their email address; null when the waitlist does not ask for it, or not yet.

invited_at*string · date-time

When the entry was invited into an Auth app; null when not invited.

invited_to_app_slug*string

Slug of the Auth app the entry was invited into; null when not invited.

metadata*object

Custom field values and anything else stored with the sign-up (`variant_id` when it was attributed to a variant).

created_at*string · date-time

When the entry signed up.

updated_at*string · date-time

When the entry last changed.

Example

Request

POST https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/{entry_id}/release
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "waitlist_id": "00000000-0000-0000-0000-000000000000",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "email": "user@example.com",
  "name": "string",
  "interest": "string",
  "referrer": "string",
  "referral_code": "string",
  "referral_count": 0,
  "referred_by_entry_id": "00000000-0000-0000-0000-000000000000",
  "position": 0,
  "is_test": false,
  "fraud_signals": [
    {
      "code": "referrer_same_device",
      "detail": "Signed up from the same device as the referrer."
    }
  ],
  "status": {},
  "confirmed_at": "2026-01-01T00:00:00.000Z",
  "invited_at": "2026-01-01T00:00:00.000Z",
  "invited_to_app_slug": "string",
  "metadata": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}