> For a complete page index, fetch https://docs.synthflow.ai/llms.txt. For full documentation content, fetch https://docs.synthflow.ai/llms-full.txt.

# Cancel a batch call

POST https://api.synthflow.ai/v2/calls/batch/{batch_call_id}/cancel

Permanently stops the batch. Recipients that have not been dialed are marked canceled and will never be called. Calls already in progress are not hung up. A canceled batch cannot be resumed and cannot take new recipients.

Reference: https://docs.synthflow.ai/api-reference/platform-api/batch-calls/cancel-a-batch-call

## Authentication

- `Authorization` header (bearer token, required)

## Servers

- `https://api.synthflow.ai/v2` (Global, default)
- `https://api.us.synthflow.ai/v2` (United States)
- `https://api.eu.synthflow.ai/v2` (European Union)

## Request

### Path parameters

- `batch_call_id` (string, required)

## Response

### 200

200

- `status` (string, optional)
- `response` (object, optional)
  - `batch_call_id` (string, optional)
  - `name` (string, optional)
  - `status` (string, optional) — One of `scheduled`, `in_progress`, `paused`, `completed` or `canceled`.
  - `total_task_count` (integer, optional) — Recipients stored in the batch.
  - `dispatched_count` (integer, optional) — Recipients whose call was placed.
  - `failed_count` (integer, optional) — Recipients whose call could not be placed.
  - `pending_count` (integer, optional) — Recipients still waiting to be dialed.
  - `created_at` (string, optional)
  - `model_id` (string, optional) — The agent placing the calls.
  - `agent_name` (string, optional)
  - `from_phone_number` (string, optional)

## Examples

**Response**

```json
{
  "status": "ok",
  "response": {
    "batch_call_id": "3f6f2f5e-4f4b-4f0e-9a4e-2b6d1a5c7e90",
    "name": "August re-engagement",
    "status": "scheduled",
    "total_task_count": 250,
    "dispatched_count": 120,
    "failed_count": 5,
    "pending_count": 125,
    "created_at": {},
    "model_id": "1631a495-e29b-4933-a0b7-3ea0f4a45e64",
    "agent_name": "Support agent",
    "from_phone_number": "+16286666348"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.synthflow.ai/v2/calls/batch/batch_call_id/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synthflow.ai/v2/calls/batch/batch_call_id/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.synthflow.ai/v2/calls/batch/batch_call_id/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.synthflow.ai/v2/calls/batch/batch_call_id/cancel")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.synthflow.ai/v2/calls/batch/batch_call_id/cancel");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.synthflow.ai/v2/calls/batch/batch_call_id/cancel")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```