Skip to main content
POST
TypeScript

Autorisaties

Authorization
string
header
vereist

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

Headers

Idempotency-Key
string

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

Maximum string length: 255
Voorbeeld:

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

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

Audience ID, prefixed adaud_.

Body

application/json
file_id
string
vereist

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

Voorbeeld:

"file_xxxxxxxxxxxxxx"

Respons

Audience upload accepted.

audience_type
enum<string>
vereist

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

Beschikbare opties:
custom,
lookalike
Voorbeeld:

"lookalike"

auto_refresh
boolean
vereist

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.

Voorbeeld:

false

created_at
string
vereist

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

Voorbeeld:

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

error_message
string | null
vereist

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.

Voorbeeld:

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

filters
object | null
vereist

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

Voorbeeld:
id
string
vereist

Audience ID, prefixed adaud_.

Voorbeeld:

"adaud_xxxxxxxxxxxxxx"

last_refreshed_at
string | null
vereist

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

Voorbeeld:

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

lookalike_ratio
number | null
vereist

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

Voorbeeld:

0.04

lookalike_starting_ratio
number | null
vereist

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

Voorbeeld:

0.02

match_rates
object[]
vereist
matched_rows
number
vereist

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

Voorbeeld:

0

name
string
vereist

Audience display name.

Voorbeeld:

"Past purchasers Lookalike 2–4%"

platform_audience_ids
string[]
vereist

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

processed_rows
number
vereist

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

Voorbeeld:

0

progress_percent
number
vereist

Processing progress from 0 to 100.

Voorbeeld:

0

source_audience_id
string | null
vereist

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

Voorbeeld:

"adaud_xxxxxxxxxxxxxx"

source_type
enum<string>
vereist

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

Beschikbare opties:
csv_upload,
people_filter,
engagement
Voorbeeld:

"csv_upload"

status
enum<string>
vereist

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.

Beschikbare opties:
pending,
processing,
ready,
partial,
failed
total_rows
number
vereist

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

Voorbeeld:

0

updated_at
string
vereist

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

Voorbeeld:

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