Skip to main content
POST
Approve Waitlist Entry

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-15"

Path Parameters

id
string
required

Waitlist signup ID, prefixed entry_.

Response

current signup state

account_id
string
required

The seller account, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

approval_failure_reason
enum<string> | null
required

Why the last approval attempt failed, or null when none has. plan_unavailable — the plan, product, or seller account was deleted. already_member — the user already has a membership on a one-per-user product. checkout_failed — checkout failed, usually a declined payment, and the signup was denied. unknown — another failure; retry. Cleared when approval is requeued.

Available options:
plan_unavailable,
already_member,
checkout_failed,
unknown,
null
Example:

"plan_unavailable"

buyer_account_id
string | null
required

The account the signup was submitted on behalf of, prefixed biz_, or null when the user signed up for themselves.

created_at
string
required

When this signup was submitted, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

custom_field_responses
object[]
required
id
string
required

The waitlist signup ID, prefixed entry_.

Example:

"entry_xxxxxxxxxxxxxx"

membership_id
string | null
required

The membership created for this signup, prefixed mem_, or null when there is none. Check the membership's status to determine access.

metadata
object
required

Custom key-value metadata associated with this signup.

Example:
plan_id
string
required

The plan this signup belongs to, prefixed plan_.

Example:

"plan_xxxxxxxxxxxxxx"

product_id
string | null
required

The product this signup belongs to, prefixed prod_, or null when the plan has no product.

Example:

"prod_xxxxxxxxxxxxxx"

status
enum<string>
required

The signup's current state. Approval runs asynchronously, so a signup stays pending until processing completes. approved alone does not prove an active membership; check membership_id.

Available options:
pending,
approved,
denied,
canceled
Example:

"canceled"

updated_at
string
required

When this signup last changed, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

user_id
string
required

The user who submitted this signup, prefixed user_.

Example:

"user_xxxxxxxxxxxxxx"