> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.simz.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.simz.com/_mcp/server.

# Pause all dispatchable batches

POST https://api.simz.com/api/lead-receive-service/agent/batches/pause-all
Content-Type: application/json

Pause every dispatchable batch (`queued` or `processing`) for your company that still has accepted backlog. Already-paused batches are skipped. Optionally scope the operation to one agent.

Reference: https://docs.simz.com/api-reference/sim-z-integration-api/batch-management/pause-all-batches

## Authentication

- `X-Company-API-Key` header (required) — Company API key issued by SimZ.

## Request

### Body (application/json)

This endpoint expects a CompanyBatchControlRequest.

- `agentId` (string, optional, nullable) — Optional agent ID. When provided, only batches for that agent are affected.

## Response

### 200

OK

- `success` (boolean, optional)
- `message` (string, optional)
- `data` (PauseAllBatchesResult, optional)

## Errors

### 401 Unauthorized Error

Missing, invalid, or expired company API key.

- `success` (boolean, optional)
- `code` (string, optional)
- `message` (string, optional)
- `error` (string, optional) — Human-readable error message when returned by batch control endpoints.

## Types

### PauseAllBatchesResult

- `pausedBatches` (integer, optional)
- `batches` (list of BatchPauseResult, optional)

### BatchPauseResult

- `batchId` (string, optional)
- `status` (string, optional)
- `pausedEntries` (integer, optional) — Number of accepted leads waiting to dial when the batch was paused.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "success": true,
  "message": "string",
  "data": {
    "pausedBatches": 1,
    "batches": [
      {
        "batchId": "string",
        "status": "paused",
        "pausedEntries": 1
      }
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.simz.com/api/lead-receive-service/agent/batches/pause-all"

payload = {}
headers = {
    "X-Company-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.simz.com/api/lead-receive-service/agent/batches/pause-all';
const options = {
  method: 'POST',
  headers: {'X-Company-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.simz.com/api/lead-receive-service/agent/batches/pause-all"

	payload := strings.NewReader("{}")

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

	req.Header.Add("X-Company-API-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	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.simz.com/api/lead-receive-service/agent/batches/pause-all")

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

request = Net::HTTP::Post.new(url)
request["X-Company-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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.simz.com/api/lead-receive-service/agent/batches/pause-all")
  .header("X-Company-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.simz.com/api/lead-receive-service/agent/batches/pause-all', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Company-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.simz.com/api/lead-receive-service/agent/batches/pause-all");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Company-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Company-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.simz.com/api/lead-receive-service/agent/batches/pause-all")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```