Audiences

Update audience

Updates an existing audience. Only fields supplied in the body are changed; omitted fields are left untouched. Sending null for name returns 400 invalid_null because name is a required attribute on the audience. Returns the updated audience.

put/v1/audiences/{audience_id}

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v1/audiences/:audience_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

audience_idstring required

Request body

component_idsstring[]

tagsstring[]

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.

Example request

{
  "enabled": "handlebars@buildtime:{{enabled}}",
  "name": "handlebars@buildtime:{{name}}"
}

Response

Updated audience.

component_idsstring[] required

idstring required

Stable Extole identifier for the audience.

tagsstring[] required

Free-form tags applied to the audience.

Example response

{
  "enabled": "handlebars@buildtime:{{enabled}}",
  "name": "handlebars@buildtime:{{name}}"
}

Changes

No recorded changes to this operation across all 1 revision of this API.