Audiences

Archive audience

Soft-archives the audience. Archived audiences disappear from default GET /v1/audiences and GET /v1/audiences/built responses; pass include_archived=true to surface them. Reversible via POST /v1/audiences/{audience_id}/unarchive. Fails if the audience is still referenced by a campaign-controller membership trigger, a create- or remove-membership controller action, or a campaign component variable.

delete/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/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

audience_idstring required

Response

Archived 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.