Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Batch Jobs API

The Batch Jobs API from Extole — 6 operation(s) for batch jobs.

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

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

This API exposes 9 operations across 6 paths, and defines 15 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.

9 operations 6 paths 15 schemas 1 DELETE4 GET3 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 Batch Jobs 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 9

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

Batch Jobs 9
GET
/v6/batches
List batch jobs
listBatches 7 params → 200400401402403415429
POST
/v6/batches
Create a batch job
createBatch body → 200400401402403415429
GET
/v6/batches/{batchId}
Get a batch job
getBatch 1 param → 200400401402403404415423
PUT
/v6/batches/{batchId}
Update a batch job
updateBatch 1 param body → 200400401402403404415423
DELETE
/v6/batches/{batchId}
Delete a batch job
deleteBatch 1 param → 200400401402403404415423
POST
/v6/batches/{batchId}/cancel
Cancel a batch job
cancelBatch 1 param → 200400401402403404415423
POST
/v6/batches/{batchId}/expire
Expire a batch job
expireBatch 1 param → 200400401402403404415423
GET
/v6/jobs/history
List job execution history
listJobsHistory 6 params → 200400401402403415429503
GET
/v6/jobs/history/{historyId}
Get a job execution history entry
getJobsHistoryEntry 1 param → 200400401402403415429503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are BatchJobCreateRequest (9 properties), TaskExecutionResponse (8 properties), JobHistoryResponse (7 properties), RestExceptionResponse (5 properties). Each schema is shown below with its type and property counts.

PatternNameMatchBatchJobColumnRequest
object
4 required
BatchJobDataSourceRequestBase
object
1 property
BatchJobCreateRequest
object
Body of a POST /v6/batches request.
9 properties 1 required
BatchJobColumnRequestBase
object
3 properties
FullNameMatchBatchJobColumnRequest
object
4 required
TaskExecutionResponse
object
8 properties
BatchJobUpdateRequest
object
Body of a PUT /v6/batches/{batchId} request.
3 properties
BatchJobDataSourceRequest
Data source for the batch job. Required. Specify one of: REPORT (a previously completed report), AUDIENCELIST (an audience list build), or FILEASSET (an upload…
AudienceListBatchJobDataSourceRequest
object
2 required
FileAssetBatchJobDataSourceRequest
object
2 required
ReportBatchJobDataSourceRequest
object
2 required
BatchJobColumnRequest
Column validation rules applied before the job begins dispatching. Each entry declares a column name and optional constraints; rows that fail validation are co…
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…
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
JobHistoryResponse
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-batch-jobs-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication 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