curl -X POST 'https://api.elevenlabs.io/v1/convai/batch-calling/batch-id/cancel' \
  -H "xi-api-key: $ELEVENLABS_API_KEY"

# POST /v1/convai/batch-calling/{batch_id}/cancel (ElevenLabs API)
Base URL: https://api.elevenlabs.io
Auth: xi-api-key: <ELEVENLABS_API_KEY>
Last verified: 2026-09-03

> Cancel A Batch Call.

## Critical Gotchas
* Authentication uses the non-standard `xi-api-key` header, not `Authorization: Bearer`. Sending a Bearer token returns HTTP 401.
* Text-to-speech responses are raw binary audio, not JSON. Write the body to a file (`--output speech.mp3`) rather than parsing it.

## cURL
curl -X POST 'https://api.elevenlabs.io/v1/convai/batch-calling/batch-id/cancel' \
  -H "xi-api-key: $ELEVENLABS_API_KEY"

## Parameters
| Name | In | Type | Required | Description |
| :--- | :--- | :--- | :--- | :--- |
| batch_id | path | string | Yes | path parameter batch_id. |

## Response (200 OK)
{"id":"string","phone_number_id":"string"}

---
Need an API key? Get one at https://elevenlabs.io/app/sign-up

POST

/v1/convai/batch-calling/{batch_id}/cancel

ElevenLabs API

Cancel A Batch Call.

Base URL: https://api.elevenlabs.io
Auth: xi-api-key: <ELEVENLABS_API_KEY>
Last verified: 2026-09-03 · upstream hash matched

Actions

Agents: curl -H "Accept: text/markdown" this URL
→ 158 tokens · Vary: Accept

Critical gotchas

Authentication uses the non-standard xi-api-key header, not Authorization: Bearer. Sending a Bearer token returns HTTP 401.

Text-to-speech responses are raw binary audio, not JSON. Write the body to a file (--output speech.mp3) rather than parsing it.

cURL

curl -X POST 'https://api.elevenlabs.io/v1/convai/batch-calling/batch-id/cancel' \  -H "xi-api-key: $ELEVENLABS_API_KEY"

Get a free ElevenLabs API key → sponsored

Parameters

Name	In	Type	Required	Description
batch_id	path	string	Yes	path parameter batch_id.

Response 200 OK

{
  "id": "string",
  "phone_number_id": "string",
  "phone_provider": "twilio",
  "whatsapp_params": {
    "whatsapp_phone_number_id": "string",
    "whatsapp_call_permission_request_template_name": "string",
    "whatsapp_call_permission_request_template_language_code": "string"
  },
  "name": "string",
  "agent_id": "string",
  "branch_id": "string",
  "environment": "string",
  "created_at_unix": 0,
  "scheduled_time_unix": 0,
  "timezone": "string",
  "total_calls_dispatched": 0,
  "total_calls_scheduled": 0,
  "total_calls_finished": 0,
  "last_updated_at_unix": 0,
  "status": "pending",
  "retry_count": 0,
  "telephony_call_config": {
    "ringing_timeout_secs": 60,
    "twilio_call_recording_enabled": false,
    "twilio_machine_detection": {
      "mode": "enable"
    }
  },
  "target_concurrency_limit": 0,
  "agent_name": "string",
  "branch_name": "string"
}