My Extole LoginGithub
API Reference

Update a batch job

put
https://api.extole.io/v6/batches/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Batch job ID.

Body Params

Body of a PUT /v6/batches/{batchId} request.

string

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

scopes
array of strings

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

tags
array of strings

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

tags
Responses
200

Batch job updated. Returns the full updated job record.

404

Batch job not found or does not belong to this client.

Updated about 1 month ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago