Cancel a task
POST/api/v2/bulk/tasks/:correlationId/cancel
Tasks are cancellable while they wait for processing to begin. A task that is already processing or already terminal yields 409 with the task's current status in the message. Cancellation is immediate and final: the response carries the task's new Cancelled state, and subscribers on the bulk.task.cancelled webhook topic are notified. A correlation id belonging to a different profile than your API key's yields 401, not 404 — 404 means the id does not exist.
Request
Responses
- 200
- 401
- 404
- 409
The task in its new Cancelled state.
Returned when the API key is missing, malformed or inactive, or when the correlation id belongs to a task created by a different profile than your API key's.
No task with this correlation id exists.
The task is already processing or already terminal; the current status is in the message.