Update Batch Call Status

Changes state - verify before retry Changes the execution status of a batch call. This is NOT a read-only action. pause halts new outbound calls (in-progress ones continue, can be resumed); resume continues a paused batch; cancel permanently stops it, removes queued calls, and marks call logs cancelled — it cannot be resumed or undone, and requires confirm: true (only set this after the user has explicitly approved cancelling this specific batch, never preemptively). pause/resume do not require confirm.

Parameters

Name	Type	Required	Description
`batch_id`	`string`	Yes	The batch ID, e.g. batch_abc123
`action`	enum: `pause` \| `resume` \| `cancel`	Yes	The status transition to apply
`confirm`	`boolean`	No	Required and must be true when action is “cancel” — irreversible. Not needed for pause/resume.

Before you call

Connect and initialize the MCP client with OAuth or an API key for the intended workspace.
Provide the required parameters: batch_id, action.
Set confirm: true only after the user approves the exact target and action.

Example MCP request

Send tools/call after your client completes MCP initialization. Replace placeholder values with IDs and inputs from your workspace. For object and array parameters, follow the nested requirements in the parameter description instead of treating an empty value as complete.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_batch_call_status",
    "arguments": {
      "batch_id": "batch_abc123",
      "action": "pause"
    }
  }
}

The server returns one text content block. Parse content[0].text as JSON when the tool succeeds. See MCP responses and errors for the full envelope and failure behavior.

Verify the result

Confirm the response is not marked isError. Call List Batch Calls to read the affected resource. Verify that the intended state is visible before making another change.

Retry safety

This tool changes workspace state. After a timeout, read the affected resource before retrying so you do not create duplicate or conflicting changes.

List Batch Calls: list_batch_calls
List Calls In Batch: list_calls_in_batch

Start Here

Tool Reference

Parameters

Before you call

Example MCP request

Verify the result

Retry safety

​Parameters

​Before you call

​Example MCP request

​Verify the result

​Retry safety

​Related MCP tools

​Related guides

Parameters

Before you call

Example MCP request

Verify the result

Retry safety

Related MCP tools

Related guides