Cancel Email Campaign
cancel_email_campaignStop an email campaign so no further emails are sent; delivered emails remain delivered. Requires business ID, campaign ID, and current revision fingerprint.
Instructions
Stop an email campaign so nothing more is sent from it. Emails already delivered stay delivered. Needs campaign_id and the fingerprint of its current revision. Business owner only.
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": {
"business_id": "<business_id>",
"campaign_id": "<campaign_id>",
"fingerprint": "<fingerprint>"
},
"name": "cancel_email_campaign"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| business_id | Yes | The business that sends the email. | |
| campaign_id | Yes | The campaign to stop. | |
| fingerprint | Yes | Fingerprint of its current revision, from get_email_campaign. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| code | No | ||
| error | No | Present when success is false | |
| action | No | ||
| status | No | ||
| success | Yes | Whether the tool completed successfully | |
| senderId | No | ||
| fingerprint | No |