Skip to main content
POST
TypeScript

Autorisations

Authorization
string
header
requis

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.

Scopes

audience:update

En-têtes

Idempotency-Key
string

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

Maximum string length: 255
Exemple:

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

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Audience ID, prefixed adaud_.

Corps

application/json
file_id
string
requis

The new customer CSV — a file id (file_...) returned by POST /files. Its headers must match the audience's saved column mapping.

Exemple:

"file_xxxxxxxxxxxxxx"

Réponse

Audience upload accepted.

audience_type
enum<string>
requis

Whether the audience targets a defined group of people or people similar to an existing audience.

Options disponibles:
custom,
lookalike
Exemple:

"lookalike"

auto_refresh
boolean
requis

Whether Whop rebuilds membership from saved People filters twice a day. When false, People audiences keep the members matched at creation. Always false for uploaded lists, lookalikes, and engagement audiences.

Exemple:

false

created_at
string
requis

When the audience was created, as an ISO 8601 timestamp.

Exemple:

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

error_message
string | null
requis

Why a pending audience hasn't started, or why a partial or failed one isn't fully built. null when there is nothing to report.

Exemple:

"412 of 1,000 rows had no email or phone number, so the list could not be matched."

filters
object | null
requis

Saved Whop People filters that define membership, using the same keys as GET /people. null for uploaded lists, engagement audiences, and lookalikes.

Exemple:
id
string
requis

Audience ID, prefixed adaud_.

Exemple:

"adaud_xxxxxxxxxxxxxx"

last_refreshed_at
string | null
requis

When the audience membership was last rebuilt, as an ISO 8601 timestamp. null until the first build completes.

Exemple:

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

lookalike_ratio
number | null
requis

For lookalikes: the upper bound of the similarity band as a fraction (0.02 = top 2%). null for custom audiences.

Exemple:

0.04

lookalike_starting_ratio
number | null
requis

For lookalikes: the lower bound of the similarity band as a fraction. null for custom audiences and first-tier lookalikes.

Exemple:

0.02

match_rates
object[]
requis
matched_rows
number
requis

Members successfully uploaded to connected ad accounts. Always 0 for lookalikes and engagement audiences.

Exemple:

0

name
string
requis

Audience display name.

Exemple:

"Past purchasers Lookalike 2–4%"

platform_audience_ids
string[]
requis

Audience IDs on the ad networks Whop sends this audience to.

processed_rows
number
requis

Members processed from the source so far. Always 0 for lookalikes and engagement audiences.

Exemple:

0

progress_percent
number
requis

Processing progress from 0 to 100.

Exemple:

0

source_audience_id
string | null
requis

For lookalikes: the audience this lookalike was built from. null for custom audiences.

Exemple:

"adaud_xxxxxxxxxxxxxx"

source_type
enum<string>
requis

Membership source: an uploaded CSV, Whop People filters, or social engagement. Engagement audiences can no longer be created.

Options disponibles:
csv_upload,
people_filter,
engagement
Exemple:

"csv_upload"

status
enum<string>
requis

Current state of audience creation. When a pending audience is waiting on something, such as an ad account to upload to, error_message says what. When status is partial or failed, error_message explains what went wrong.

Options disponibles:
pending,
processing,
ready,
partial,
failed
total_rows
number
requis

Total members detected in the source — CSV rows for uploaded lists, matching people for automatic audiences. Always 0 for lookalikes and engagement audiences.

Exemple:

0

updated_at
string
requis

When the audience was last updated, as an ISO 8601 timestamp.

Exemple:

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