Cancel a broadcast send
broadcasts_cancelRequests cancellation for delivery work that has not reached the provider. Provider-accepted emails cannot be recalled. Repeat the same request with the same idempotency key when the response is lost. Effect: external-email. Retry with the same idempotency_key. Permissions: live_actions:write, broadcasts:write. API reference: https://mailrith.com/developers/api-reference.
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": {
"broadcast_id": "<broadcast_id>"
},
"name": "broadcasts_cancel"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| broadcast_id | Yes | The broadcast identifier. | |
| idempotency_key | No | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| response | No | ||
| request_id | Yes | The stable correlation ID for this MCP tool invocation. | |
| operation_id | Yes | The stable Mailrith public API operation ID. |