Skip to main content
PUT
Update audience

Authorizations

Authorization
string
header
required

Path Parameters

audience_id
string
required

Body

application/json

Body of a PUT /v1/audiences/{audience_id} request.

component_ids
string[]
component_references
object[]
enabled

New enabled flag. Disabling an audience leaves the definition in place but prevents the runtime from evaluating it.

name

New display name. Same shape and 255-character cap as on POST /v1/audiences. Sending null returns 400 invalid_null because name is required on the audience.

tags
string[]

Replaces the audience's tag set with the supplied set. Pass an empty set to clear all tags. Each tag must be 255 characters or fewer.

Response

Updated audience.

Stored audience definition. Fields name and enabled are unevaluated and appear in buildtime-evaluatable form.

component_ids
string[]
required
component_references
object[]
required
enabled
required

Whether the audience is currently evaluated at runtime.

id
string
required
read-only

Stable Extole identifier for the audience.

name
required

Display name for the audience, in the same buildtime-evaluatable form that was supplied on create or update.

tags
string[]
required

Free-form tags applied to the audience.