Skip to main content
POST
Approve All Waitlist Entries

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

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-10-09-2"

Body

application/json
account_id
string
required

The seller account whose pending signups to approve, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

plan_id
string

Only approve signups for this variant, prefixed plan_. Omit to include every waitlist variant on the account.

Response

approval queued

account_id
string
required

The seller account whose signups were queued, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

plan_id
string | null
required

The variant the request was narrowed to, prefixed plan_, or null when every waitlist variant on the account was included.

Example:

null

queued
boolean
required

Whether any pending signups were queued for approval. false when there were none.

Example:

true