Batch Jobs
Cancel a batch job
Requests cancellation of a batch job. The job transitions to CANCELED status. Only jobs in a non-terminal state (PENDING, QUEUED, IN_PROGRESS, or DISPATCHING) can be canceled.
post/v6/batches/{batchId}/cancel
Request
- Base URLhttps://api.extole.io
- Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
batchIdstring required
Batch job ID.
Response
Cancellation accepted. Returns the updated job record with status: CANCELED.
Changes
No recorded changes to this operation across all 1 revision of this API.