v9

OpenAPI 3.1.02026-08-043703845.2 MB

Audiences

Update Audience

Renames an audience. For an audience built from People filters that keeps itself up to date, pass filters to replace them, which rebuilds membership immediately. Whether an audience auto refreshes is set when it is created.

patch/audiences/{audience_id}

Path parameters

audience_idstring required

Audience ID, prefixed adaud_.

Request body

filtersobject

Replaces the People filters that define membership. The whole definition is replaced rather than merged, so send every filter you want to keep — a filter you leave out stops applying. Keys and values are the ones GET /people accepts, such as an os of iOS or a country of US, and at least one filter is required. Date filters must be rolling windows — first_seen_within_days or last_seen_within_days — so the audience re-anchors every time it rebuilds; fixed dates such as first_seen_after are rejected, as is audience_id. An array value holds at most 500 items, and each value at most 10 KB. Only an audience with a source_type of people_filter and auto_refresh of true accepts filters: an uploaded list has no filters to replace, and with auto refresh off the audience keeps the people it matched when it was built, so create a new audience instead.

namestring

New audience display name. A blank value is ignored rather than clearing the name.

Response

Audience updated.

audience_type'custom' | 'lookalike' required

custom = a customer list (uploaded, or built from saved People filters); lookalike = Meta lookalike built from a custom audience.

auto_refreshboolean required

Whether membership keeps updating. true rebuilds it from the saved filters twice a day, so people join and leave as they start and stop matching. false keeps whoever matched when it was built and never rebuilds. Always false for uploaded lists and lookalikes.

created_atstring required

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

error_messagestring nullable required

Processing error message. null unless processing is partial or failed.

filtersobject nullable required

For audiences built from People filters: the filters that define membership, keyed exactly as GET /people accepts them — for example {"os": "iOS", "country": "US"}. null for uploaded lists and lookalikes.

idstring required

Audience ID, prefixed adaud_.

last_refreshed_atstring nullable required

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

lookalike_rationumber nullable required

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

lookalike_starting_rationumber nullable required

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

matched_rowsnumber required

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

namestring required

Audience display name.

platform_audience_idsstring[] required

processed_rowsnumber required

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

progress_percentnumber required

Processing progress from 0 to 100.

source_audience_idstring nullable required

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

source_type'csv_upload' | 'people_filter' required

Where members come from. csv_upload = an uploaded customer list; people_filter = built from saved People filters. See auto_refresh for whether a people_filter audience keeps updating.

Current state of the audience import. syncing means Whop is sending matched rows to connected ad accounts. When status is partial or failed, error_message explains what went wrong.

total_rowsnumber required

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

updated_atstring required

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

Example response

{
  "audience_type": "custom",
  "match_rates": [
    {
      "platform": "meta",
      "status": "calculating"
    }
  ],
  "source_type": "csv_upload"
}