v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Audiences

Create audience

Creates a new audience definition. name is required; enabled, tags, and component_references are optional. New audiences default to enabled. Tags must be 255 characters or fewer each; the resolved name must also be 255 characters or fewer. Returns the created audience.

post/v1/audiences

Request body

component_idsstring[]

tagsstring[]

Free-form tags applied to the audience. Used to organise audiences in the dashboard and to filter them in API queries. Each tag must be 255 characters or fewer.

Example request

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

Response

Created 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}}"
}