cancel_batch
Cancel a batch by batch_uuid when the user no longer wants it verified, for example a list submitted by mistake. Every address no worker has started is canceled and the tokens it reserved go back to the wallet at once; an address already being verified finishes and is billed as usual. The batch ends canceled and takes no more append_batch_emails chunks. Canceling a canceled batch changes nothing; a batch that already completed or failed cannot be canceled (cancel_batch.not_cancelable). Returns the batch as get_batch does, with tokens_billed and tokens_reserved after the refund. Requires the email:verify:bulk scope.
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_uuid": "<batch_uuid>"
},
"name": "cancel_batch"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch_uuid | Yes | Public batch UUID returned by submit_batch or list_batches. |