add_suppressions
Add up to 500 addresses of ONE channel to the account do-not-contact list. Idempotent, and it never downgrades an existing opt-out. This is the safe direction — suppressing costs nothing and protects the account, so no confirmation is required. The response separates Added from AlreadySuppressed and Invalid; report those counts rather than claiming every address was added. 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": {
"channel": "<channel>",
"addresses": "<addresses>"
},
"name": "add_suppressions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| channel | Yes | email or sms — one channel per call | |
| addresses | Yes | 1 to 500 email addresses, or phone numbers (E.164 or 10-digit US/CA) |