How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Audiences API

The Audiences API from Extole — 17 operation(s) for audiences.

Extole Audiences API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Audiences. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 21 operations across 17 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

21 operations 17 paths 48 schemas 1 DELETE13 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Audiences API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 21

Across 17 paths, the API surfaces 21 operations — 1 DELETE, 13 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Audiences 21
GET
/v1/audiences
List audiences
listAudiences 3 params → 200400401402403415429
POST
/v1/audiences
Create audience
createAudience body → 200400401402403415429
GET
/v1/audiences/built
List built audiences
listBuiltAudiences 5 params → 200400401402403415429
GET
/v1/audiences/{audience_id}
Get audience
getAudience 1 param → 200400401402403415429
PUT
/v1/audiences/{audience_id}
Update audience
updateAudience 1 param body → 200400401402403415429
DELETE
/v1/audiences/{audience_id}
Archive audience
archiveAudience 1 param → 200400401402403415429
GET
/v1/audiences/{audience_id}/built
Get built audience
getBuiltAudience 1 param → 200400401402403415429
GET
/v1/audiences/{audience_id}/members
List audience member IDs
listAudienceMemberIds 7 params → 200400401402403415429
GET
/v1/audiences/{audience_id}/members/download{format}
Download audience members
downloadAudienceMembers 7 params → 200400401402403415429
GET
/v1/audiences/{audience_id}/members/view/details
List audience members
listAudienceMembers 7 params → 200400401402403415429
GET
/v1/audiences/{audience_id}/operations
List audience operations
listAudienceOperations 7 params → 200400401402403415429
POST
/v1/audiences/{audience_id}/operations
Create an audience operation
createAudienceOperation 1 param body → 200400401402403415429
GET
/v1/audiences/{audience_id}/operations/{operation_id}
Get an audience operation
getAudienceOperation 2 params → 200400401402403415429
GET
/v1/audiences/{audience_id}/operations/{operation_id}/state
Get audience operation state
getAudienceOperationState 2 params → 200400401402403415429
GET
/v1/audiences/{audience_id}/operations/{operation_id}/state/debug
Get audience operation debug state
getAudienceOperationStateDebug 2 params → 200400401402403415429
GET
/v1/audiences/{audience_id}/operations/{operation_id}/view/details
Get audience operation with details
getAudienceOperationWithDetails 2 params → 200400401402403415429
GET
/v1/audiences/{audience_id}/stats
Get audience membership statistics
getAudienceStats 1 param → 200400401402403415429
POST
/v1/audiences/{audience_id}/delete
Delete audience
deleteAudience 1 param → 200400401402403415429
POST
/v1/audiences/{audience_id}/operations/{operation_id}/cancel
Cancel an audience operation
cancelAudienceOperation 2 params → 200400401402403415429
POST
/v1/audiences/{audience_id}/operations/{operation_id}/retry
Retry an audience operation
retryAudienceOperation 2 params → 200400401402403415429
POST
/v1/audiences/{audience_id}/unarchive
Unarchive audience
unarchiveAudience 1 param → 200400401402403415429

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are AudienceMemberWithDataResponse (12 properties), AudienceOperationStateDebugResponseBase (9 properties), AudienceOperationStateResponseBase (7 properties), AudienceOperationDetailedResponse (7 properties). Each schema is shown below with its type and property counts.

AudienceOperationCreateRequest
object
Body of a POST /v1/audiences/{audienceid}/operations request.
3 properties 2 required
AudienceOperationDataSourceRequest
ReportAudienceOperationDataSourceRequest
object
2 required
EnabledInAudienceResponse
Whether the audience is currently evaluated at runtime.
ActionAudienceOperationStateResponse
object
7 required
AudienceOperationStateResponse
7 required
ModificationAudienceOperationStateResponseAsAdd
object
9 required
EnabledInAudienceCreateRequest
Whether the audience evaluates at runtime. Defaults to true when omitted. Provide a literal boolean or a buildtime evaluatable that resolves to a boolean.
AudienceOperationDataSourceResponseBase
object
1 property
FileAssetAudienceOperationDataSourceResponse
object
5 required
ComponentReferenceResponse
object
2 properties
NameInAudienceResponse
Display name for the audience, in the same buildtime-evaluatable form that was supplied on create or update.
ModificationAudienceOperationStateDebugResponseAsAdd
object
11 required
NameInAudienceUpdateRequest
New display name. Same shape and 255-character cap as on POST /v1/audiences. Sending null returns 400 invalidnull because name is required on the audience.
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
AudienceStatsResponse
object
1 property 1 required
ComponentReferenceRequest
object
2 properties
MemberResponse
object
4 properties
FileAssetAudienceOperationDataSourceRequest
object
2 required
PersonListAudienceOperationDataSourceResponse
object
2 required
ModificationAudienceOperationStateDebugResponseAsReplace
object
11 required
ModificationAudienceOperationStateResponseAsRemove
object
9 required
ActionAudienceOperationDataSourceRequest
object
2 required
AudienceUpdateRequest
object
Body of a PUT /v1/audiences/{audienceid} request.
5 properties
ActionAudienceOperationStateDebugResponse
object
9 required
PersonDataResponse
object
6 properties 6 required
AudienceOperationDataSourceResponse
AudienceOperationStateResponseBase
object
7 properties
EnabledInAudienceUpdateRequest
New enabled flag. Disabling an audience leaves the definition in place but prevents the runtime from evaluating it.
PersonListAudienceOperationDataSourceRequest
object
2 required
AudienceOperationResultResponse
object
4 properties
AudienceOperationResponse
object
4 properties 4 required
AudienceCreateRequest
object
Body of a POST /v1/audiences request.
5 properties 1 required
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
ActionAudienceOperationDataSourceResponse
object
4 required
AudienceOperationStateDebugResponseBase
object
9 properties
AudienceResponse
object
Stored audience definition. Fields name and enabled are unevaluated and appear in buildtime-evaluatable form.
6 properties 6 required
AudienceMemberWithDataResponse
object
12 properties 12 required
NameInAudienceCreateRequest
Display name for the audience. Provide a literal string (provided@buildtime:My audience) or any buildtime evaluatable that resolves to a string. Must be 255 ch…
AudienceOperationDataSourceRequestBase
object
1 property
MemberRequest
object
3 properties
ModificationAudienceOperationStateResponseAsReplace
object
9 required
ModificationAudienceOperationStateDebugResponseAsRemove
object
11 required
BuiltAudienceResponse
object
audience after buildtime evaluation. Fields name and enabled are already evaluated.
6 properties 6 required
ReportAudienceOperationDataSourceResponse
object
5 required
AudienceOperationStateDebugResponse
9 required
AudienceOperationDetailedResponse
object
7 properties 7 required
PersonLocaleResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-audiences-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API
Extole Components Subscriptions API
Where this information came from

This is an independent, third-party profile of Extole Audiences API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.