cancel_batch
Cancel every letter of a batch at once, only after explicit user approval and only before any is in preparation; each is fully refunded to the balance. Volume-priced batch letters can be cancelled only this way.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"batch_id": "<batch_id>",
"approved": "<approved>",
"idempotency_key": "<idempotency_key>"
},
"name": "cancel_batch"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| approved | Yes | ||
| batch_id | Yes | ||
| idempotency_key | Yes |