Skip to main content
PUT
Update a batch job

Authorizations

Authorization
string
header
required

Path Parameters

batchId
string
required

Batch job ID.

Body

application/json

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

name
string

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

scopes
enum<string>[]

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

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

Available options:
CLIENT_ADMIN,
CLIENT_SUPERUSER
tags
string[]

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

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.