List suppressions
See which addresses your project does not send to, and why.
/v1/emails/suppressionsAuthorization
Bearer token
- Authorizationrequiredheader
Send your API key as
Bearer YOUR_API_KEY.
Query parameters
searchoptionalstringPart of an email address, 1–255 characters.
limitoptionalinteger1–100; defaults to 50.
cursoroptionalstringThe previous response's
nextCursor.
Response
Addresses are listed alphabetically, once each. Sends to a listed address are created with status suppressed and are not delivered or counted toward your allowance. Continue with nextCursor while hasMore is true.
emailstringThe suppressed address.
reasonstringWhy it is suppressed. When an address has several reasons, the one that applies to your sends.
| Reason | Meaning |
|---|---|
hard_bounce | Email could not be delivered to this address. |
complaint | The recipient reported an email as spam. |
unsubscribed | The recipient unsubscribed. |
invalid | The address cannot receive email. |
manual | Delivery to this address is blocked. |
temporary_failure | Recent deliveries failed temporarily; the suppression expires on its own. |
The list covers suppressions for your project and its organization. A send can also be suppressed for reasons that are not listed here, such as a contact who unsubscribed in Contacts or a block that applies across Nexiom Connect; retrieve the email to see the delivery_reason of a specific send.