Suppressions
Your suppression list holds the phone numbers and email addresses you must not send to. Messages to a suppressed number or address are refused, whichever way you send them.
Connect adds to the list automatically, for example when someone replies STOP to an SMS or unsubscribes from a marketing email. See SMS Compliance and Email Compliance. You can also manage the list yourself.
How it was added
Section titled “How it was added”Each suppression has a source:
| Source | Added by |
|---|---|
api | You, through the API or the dashboard |
web | The recipient used an opt-out link |
stop | A STOP reply to an SMS |
bounce | A hard bounce (email only) |
complaint | A spam complaint (email only) |
system | Connect (email only) |
Email scope
Section titled “Email scope”An email suppression has a scope. all blocks every email to the address, and marketing blocks marketing email only, so receipts and login codes still arrive. Phone suppressions have no scope.
Managing the list
Section titled “Managing the list”POST /v2/suppressionsadds anumberor anemail, not both. For an email you can setscope, which defaults toall. Adding one that is already suppressed returns the existing suppression.GET /v2/suppressionslists phone and email suppressions together, newest first. Usetypeto list onlyphoneor onlyemail.DELETE /v2/suppressions/{value}removes a number or address, so you can send to it again. Removing an email address removes it from every scope.
{ "number": "+447700900123", "reason": "Asked us to stop by phone"}