Learn how to use Suppression API V6.
Overview
The Suppression API helps you manage domains and email addresses that should be excluded from communication. It allows you to add, remove, list, and check suppression status for both domains and individual email addresses.
Important points to remember
- Max 1000 entries can be added or removed in one request.
- All suppression changes are processed asynchronously.
- Email addresses may be stored in hashed format (SHA1 or SHA512_256) depending on client settings.
- Timestamps are in ISO 8601 format.
Common Error Codes
Refer to the given table to know the common error codes returned by the API and their descriptions.
| Status Code | Description |
|---|---|
| 400 | Bad Request – Invalid input or format |
| 401 | Unauthorized – Missing or invalid API key |
| 500 | Internal Server Error |
Suppression Status Codes
Refer to the given table to know the status codes used for email suppression and their corresponding meanings.
| Status ID | Meaning |
|---|---|
| 1 | Confirmed (active, not suppressed) |
| 2 | Removed due to unsubscribe |
| 3 | Removed due to bounce |
| 4 | Removed due to abuse/spam report |
| 5 | Manually removed |
| 6 | Synced from another account |
Endpoints
Refer to the given table to know the endpoints available under the Suppression API.
| Endpoint Name | Method | Endpoint | Description |
|---|---|---|---|
| Add Domain to Suppression List | POST | /v6/suppression/domains | Adds one or more domains to the suppression list, preventing any emails from being sent to these domains. |
| Remove Domain from Suppression List | DELETE | /v6/suppression/domains | Removes one or more domains from the suppression list, allowing communication to be sent to these domains again. |
| List Suppressed Domains | GET | /v6/suppression/domains | Retrieves a paginated list of domains currently suppressed, with optional filters for date range and pagination. |
| Get Domain Suppression Status | GET | /v6/suppression/domains/{domain} | Checks whether a specific domain is currently suppressed in the suppression list. |
| Add Email to Suppression List | POST | /v6/suppression/emails | Adds one or more email addresses to the suppression list, ensuring no further communication is sent to these addresses. |
| Remove Email from Suppression List | DELETE | /v6/suppression/emails | Removes one or more email addresses from the suppression list, allowing them to receive emails again. |
| List Suppressed Emails | GET | /v6/suppression/emails | Retrieves a paginated list of email addresses that are suppressed, with optional filters for date range and pagination. |
| Get Email Suppression Status | GET | /v6/suppression/emails/{email} | Checks whether a specific email address is currently suppressed in the suppression list. |