cancel_campaign
Cancel a campaign that has not finished and release the monthly allowance it was holding. CANNOT BE UNDONE — a cancelled campaign cannot be resumed, and messages already sent stay sent. confirm=true is REQUIRED. If the user only wants to stop it for now, use pause_campaign instead, which keeps the allowance and allows a resume — always offer that alternative first. Requires the Send Message module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support. When a send is refused, call fetch_messaging_usage first: it is what distinguishes module access, plan channels, an exhausted allowance, a sending pause and a missing 10DLC number.
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": {
"campaign_token": "<campaign_token>",
"confirm": "<confirm>"
},
"name": "cancel_campaign"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true. Set it ONLY after the user explicitly approved THIS action in this conversation, having been told what it does and that it cannot be taken back: the campaign ends permanently and cannot be resumed; its monthly allowance is released and messages already sent stay sent. Never assume, never carry an approval over from a previous item, never set it to satisfy the schema. | |
| campaign_token | Yes | The campaign token (UUID v4) of a campaign in status scheduled, queued, sending, paused or blocked |