Update audience

put

https://api.delivr.ai/api/v1/audiences/{id}

Update audience name, description, filter, output path, or select clause.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Audience ID.

Body Params

audience_description

string

Updated description.

audience_name

string

Updated audience name.

filter

object

A group of filter rules joined by a logical operator. Groups can be nested
to create complex expressions (e.g., AND of ORs).

intent_window_days

integer

1 to 14

Updated lookback window (1-14). Changing this triggers reprocessing. Only for intents audiences.

Rejected when the audience is pinned to a fixed date range, because the pinned range takes precedence and the new window would have no effect.

output_path

string

Updated output path.

renew_frequency

string

enum

Update the refresh schedule.

daily: refreshes every day at 09:00 UTC.
weekly: refreshes every Saturday at 18:00 UTC.
manual: stops automatic refresh; manual /refresh calls still work.

Allowed:

row_grain

string

enum

Updated row grain. Only for intents audiences. Changing the grain in effect triggers reprocessing, since it changes the shape of every output row.

Setting it to the grain the audience already builds at, including one that was previously derived from the window, is accepted and persists the choice without forcing a rebuild.

Allowed:

select

string

Updated column projection clause.

sql_filter_statement

object

Updated SQL filter statement.

tier

string

enum

Defaults to intent

Intents audiences only. intent (the default) delivers intent records without trend columns and bills as Intent Signals. predictive_signals adds intent_trend and active_days_14d to every record and bills as Predictive Signals, twice the Intent Signals rate. Trend columns are included automatically at predictive_signals. Naming a trend column in select at intent returns 400 (intent_trend is a Predictive Signals field. Set tier to predictive_signals to include trends (billed as Predictive Signals).), and predictive_signals on a non-intents audience returns 400. Filtering on trend fields is allowed at either tier. Changing the tier rebuilds the audience.

Allowed:

Responses

400

Invalid request body.

401

Missing or invalid authentication.

403

Forbidden.

404

Audience not found.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Updated audience.