← Back to API index
POST /batch/cancel

Cancel batch job

Options

Options are grouped for easier scanning, similar to parameter-focused docs.

App

id

query integer Required

Batch ID

Responses

200

Batch canceled

▾ 
{
  "success": true,
  "data": {
    "id": 98765,
    "status": "error",
    "count": 150,
    "processed": 42,
    "failed": 108,
    "error": "Canceled by user"
  }
}
400

Invalid batch ID

▾ 
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
404

Batch not found

▾ 
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}