Skip to main content
POST
/
api
/
v1
/
batches
/
{id}
/
cancel
curl -X POST "https://api.bouncedetector.com/api/v1/batches/507f1f77bcf86cd799439011/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "message": "Batch cancelled",
  "batch": {
    "_id": "507f1f77bcf86cd799439011",
    "status": "cancelled",
    "totalCount": 100,
    "processedCount": 45,
    "createdAt": "2025-03-09T14:25:00.000Z"
  }
}
Cancel a pending or processing batch. Completed or already cancelled batches cannot be cancelled.

​
Request

​
id
string
required
Batch ID to cancel

​
Response

​
message
string
Confirmation message
​
batch
object
Updated batch with status cancelled
curl -X POST "https://api.bouncedetector.com/api/v1/batches/507f1f77bcf86cd799439011/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "message": "Batch cancelled",
  "batch": {
    "_id": "507f1f77bcf86cd799439011",
    "status": "cancelled",
    "totalCount": 100,
    "processedCount": 45,
    "createdAt": "2025-03-09T14:25:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Your API key (e.g. bdt_abc123...). Obtain from the dashboard.

Path Parameters

​
id
string
required

Response

Batch cancelled

​
message
string
​
batch
object
Last modified on March 9, 2026