Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
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}

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.