---
title: "Cancel A Batch Call."
method: POST
path: "/v1/convai/batch-calling/{batch_id}/cancel"
tags: ["Agents Platform"]
---

# Cancel A Batch Call.

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

Cancel a running batch call and set all recipients to cancelled status.

## Path parameters

- `batch_id` string, required

## Headers

- `xi-api-key` string, nullable — Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Response `200`

Successful Response

- BatchCallResponse
  - `id` string, required
  - `phone_number_id` string, nullable, required
  - `phone_provider` 'twilio' | 'sip_trunk' | 'exotel', required
  - `whatsapp_params` BatchCallWhatsAppParams, required
    - `whatsapp_phone_number_id` string, nullable
    - `whatsapp_call_permission_request_template_name` string, required
    - `whatsapp_call_permission_request_template_language_code` string, required
  - `name` string, required
  - `agent_id` string, required
  - `branch_id` string, nullable, required
  - `environment` string, nullable, required
  - `created_at_unix` integer, required
  - `scheduled_time_unix` integer, required
  - `timezone` string, nullable, required
  - `total_calls_dispatched` integer, required
  - `total_calls_scheduled` integer, required
  - `total_calls_finished` integer, required
  - `last_updated_at_unix` integer, required
  - `status` 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled', required
  - `retry_count` integer, required
  - `telephony_call_config` TelephonyCallConfig, required
    - `ringing_timeout_secs` integer — How long to ring the recipient before giving up, in seconds. Note that this will also be limited by the provider's own constraints.
    - `twilio_call_recording_enabled` boolean — Whether to record the call using Twilio call recording. Ignored for non-Twilio providers. Recordings are stored in your Twilio account.
  - `target_concurrency_limit` integer, nullable, required — Maximum number of simultaneous calls for this batch. When set, dispatch is governed by this limit rather than workspace/agent capacity percentages.
  - `agent_name` string, required
  - `branch_name` string, nullable, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/versions/e77a0a530a82/schema)