Suppressions
List suppressions
Get the org suppression list: the emails and phone numbers excluded from automated messaging.
GET
List suppressions
Authorizations
Bearer token authentication using your API key
Query Parameters
Search by email or phone identifier.
Maximum string length:
256The channel an identifier is suppressed on
Available options:
EMAIL, PHONE Why the identifier is suppressed
Available options:
BOUNCE, COMPLAINT, UNSUBSCRIBE, MANUAL, LEGAL What put the identifier on the list
Available options:
WEBHOOK, UNSUBSCRIBE_LINK, ADMIN, IMPORT, API Page number
Number of items to take
Next page token (Only used on special endpoints)
Response
200 - application/json
The channel an identifier is suppressed on
Available options:
EMAIL, PHONE Why the identifier is suppressed
Available options:
BOUNCE, COMPLAINT, UNSUBSCRIBE, MANUAL, LEGAL What put the identifier on the list
Available options:
WEBHOOK, UNSUBSCRIBE_LINK, ADMIN, IMPORT, API Diagnostic context kept alongside a suppression
Who added the entry. Null when it landed automatically (bounce, complaint, unsubscribe link).