Skip to main content
POST
/
batch-calls
curl -X POST "https://api.magpipe.ai/functions/v1/batch-calls" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "cancel",
    "batch_id": "f1e2d3c4-5678-9012-3456-789012345678"
  }'

{
  "success": true,
  "message": "Batch cancelled"
}
Cancels a batch call campaign. All pending recipients are marked as skipped. Active calls are not interrupted.
Only batches in draft, scheduled, running, or paused status can be cancelled. Completed or already-cancelled batches will return an error.

​
Body Parameters

​
action
string
required
Must be cancel
​
batch_id
string
required
UUID of the batch to cancel.
curl -X POST "https://api.magpipe.ai/functions/v1/batch-calls" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "cancel",
    "batch_id": "f1e2d3c4-5678-9012-3456-789012345678"
  }'

{
  "success": true,
  "message": "Batch cancelled"
}