Suppressions
Addresses and domains that are never emailed. 3 endpoints, each also a tool for your AI through MCP. Authentication and errors are on the overview.
Suppressed addresses and domains
GET/api/v1/suppressions
MCP tool list_suppressionsRead-only
Parameters
searchquery · stringkindquery · "all" | "email" | "domain"pagequery · integerpageSizequery · integer
Returns
suppressionsrequiredobject[]totalrequirednumberemailsrequirednumberdomainsrequirednumber
curl https://ballast.to/api/v1/suppressions \
-H "Authorization: Bearer $BALLAST_API_KEY"Suppress addresses or whole domains
POST/api/v1/suppressions
Up to 10,000 values per call: emails, or domains written as @acme.com. Matching leads are marked suppressed.
MCP tool add_suppressions
Parameters
valuesrequiredstring[]reasonstring
Returns
addedrequirednumberexistingrequirednumberinvalidrequiredstring[]leadsSuppressedrequirednumber
curl -X POST https://ballast.to/api/v1/suppressions \
-H "Authorization: Bearer $BALLAST_API_KEY" \
-H "Content-Type: application/json" \
-d '{"values":[]}'Remove suppressions
POST/api/v1/suppressions/remove
Leads covered by no other suppression become active again.
MCP tool remove_suppressionsOwners and adminsMCP asks to confirm
Parameters
idsrequiredstring[]
Returns
removedrequirednumberleadsReleasedrequirednumber
curl -X POST https://ballast.to/api/v1/suppressions/remove \
-H "Authorization: Bearer $BALLAST_API_KEY" \
-H "Content-Type: application/json" \
-d '{"ids":[]}'