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.0.1, at version 1.0.
Requests are made against a single base URL, https://{brand}.extole.io.
21 operations17 paths48 schemas1 DELETE13 GET6 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.1
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.
The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are AudienceMemberWithDataResponse (12 properties), AudienceOperationStateDebugResponseBase (9 properties), AudienceOperationDetailedResponse (7 properties), AudienceOperationStateResponseBase (7 properties). Each schema is shown below with its type and property counts.
AudienceOperationStateResponseBase
object
7 properties
ReportAudienceOperationDataSourceResponse
object
5 required
PersonListAudienceOperationDataSourceResponse
object
2 required
AudienceOperationStateDebugResponse
9 required
ActionAudienceOperationDataSourceResponse
object
4 required
AudienceMemberWithDataResponse
object
12 properties12 required
AudienceOperationDataSourceResponseBase
object
1 property
AudienceUpdateRequest
object
Body of a PUT /v1/audiences/{audienceid} request.
5 properties
AudienceOperationDataSourceRequest
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…
MemberResponse
object
4 properties
AudienceStatsResponse
object
1 property1 required
AudienceOperationDataSourceRequestBase
object
1 property
AudienceOperationDataSourceResponse
BuiltAudienceResponse
object
audience after buildtime evaluation. Fields name and enabled are already evaluated.
6 properties6 required
NameInAudienceResponse
Display name for the audience, in the same buildtime-evaluatable form that was supplied on create or update.
AudienceOperationStateResponse
7 required
FileAssetAudienceOperationDataSourceResponse
object
5 required
ActionAudienceOperationDataSourceRequest
object
2 required
MemberRequest
object
3 properties
AudienceOperationResultResponse
object
4 properties
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.
Body of a POST /v1/audiences/{audienceid}/operations request.
3 properties2 required
AudienceOperationResponse
object
4 properties4 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.
[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…
RestExceptionResponse
object
Represents the API error response
5 properties5 required
ComponentReferenceResponse
object
2 properties
EnabledInAudienceResponse
Whether the audience is currently evaluated at runtime.
ReportAudienceOperationDataSourceRequest
object
2 required
PersonDataResponse
object
6 properties6 required
ComponentReferenceRequest
object
2 properties
PersonLocaleResponse
object
2 properties
EnabledInAudienceUpdateRequest
New enabled flag. Disabling an audience leaves the definition in place but prevents the runtime from evaluating it.
