Audiences21

Authentication12

Batch Jobs9

Blocks6

Campaigns34

Components23

Components Settings11

Content4

Domains7

Email8

Erasure1

Event Streams15

Events5

File Validation Monitors15

Files7

Optout1

Persons32

Profile Assets4

Profiles45

Promotion Links3

Report Schedules7

Report Types6

Reports17

Reward Suppliers27

Rewards14

Security Keys7

Settings9

SFTP Servers7

User Notifications14

User Subscriptions6

Users14

Webhooks7

Zone Rendering3

Batch Jobs

Update a batch job

Updates the mutable fields of an existing batch job: name, tags, and scopes. The job must not be in a terminal state (DONE, FAILED, CANCELED, or EXPIRED). Data source, event name, and column mappings are immutable after creation.

put/v6/batches/{batchId}

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/v6/batches/:batchId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

batchIdstring required

Batch job ID.

Request body

namestring

Updated human-readable label for the batch job. Omit to leave unchanged.

scopesstring[]

Updated access-control scopes. Accepted values: CLIENT_SUPERUSER, CLIENT_ADMIN. Omit to leave unchanged.

tagsstring[]

Updated string labels for filtering and grouping. Replaces the existing tag set. Omit to leave unchanged.

Response

Batch job updated. Returns the full updated job record.

Changes

No recorded changes to this operation across all 1 revision of this API.