Suppressions
The addresses this workspace will not send to, and the people who unsubscribed.
Suppressions tools
| Tool | What it does |
|---|---|
| listSuppressions | Every address this workspace will not send to, newest first: hard bounces, complaints and the ones blocked by hand. Returned a page at a time. |
| addSuppression | Stop sending to an address. Adding one already listed changes nothing. |
| removeSuppression | Allow mail to an address again. A hard bounce stays. A chat always asks first. |
| listUnsubscribes | The people who asked for no more marketing mail, newest first. Broadcasts and automations skip them. |
| addUnsubscribe | Record an unsubscribe somebody asked for by phone or in a reply. Their audiences are unsubscribed at once. |
| removeUnsubscribe | Take back an unsubscribe the team recorded. One the person made stays. A chat always asks first. |
Reading needs settings:read and changing needs settings:write, the scopes the Blocked addresses screen is gated on. The list stops mail from every address in the workspace, so only its owner, through an app that reaches every address, can change it.
Adding and removing fire the suppression.added and suppression.removed webhooks, the same as the screen does.
An unsubscribe covers the whole workspace and outlasts removing the person from an audience or deleting the contact. Recording one fires contact.unsubscribed, and taking one back fires contact.resubscribed.
Reference
listSuppressions
The addresses this workspace will not send to, newest first: every one that bounced hard, complained, or was added by hand. A send to one of them is refused for that recipient before anything leaves. q searches the address, the reason and the detail, and reason keeps one kind. A bounce is permanent here and cannot be removed; a complaint or a manual entry can. One page at a time: when more follow, the last line gives a cursor to pass back for the next page.
Inputs
qstring- Up to 320 characters
reasonstring- One of
"bounce""complaint""manual" limitinteger- At least 1At most 100
cursorstring
Also available in
- API
GET /suppressionsGET /suppressions/{id}- TypeScript
nextmail.suppressions.list()nextmail.suppressions.listAll()nextmail.suppressions.iterate()nextmail.suppressions.get()- Python
suppressions.list()suppressions.list_all()suppressions.iterate()suppressions.get()- Ruby
suppressions.listsuppressions.list_allsuppressions.iteratesuppressions.get- PHP
suppressions->listsuppressions->listAllsuppressions->iteratesuppressions->get- Go
Suppressions.ListSuppressions.ListAllSuppressions.IterateSuppressions.Get- Java
suppressions().listsuppressions().listAllsuppressions().iteratesuppressions().get- C#
Suppressions.ListAsyncSuppressions.ListAllAsyncSuppressions.IterateAsyncSuppressions.GetAsync
addSuppression
Put an address on the suppression list by hand, so no address in this workspace sends to it again until it is removed. Adding one that is already there changes nothing and says why it was listed. Subscribers of suppression.added hear about a new entry.
Inputs
emailstringRequired- Up to 320 charactersFormat
email
Also available in
removeSuppression
Take an address off the suppression list, so mail may go to it again. Only a complaint or a manual entry can be removed; a hard bounce stays, because the address could not take mail. Subscribers of suppression.removed hear about it.
Inputs
emailstringRequired- Up to 320 charactersFormat
email
Also available in
listUnsubscribes
The people who asked this workspace for no more marketing mail, newest first. An unsubscribe covers the whole workspace and outlasts removing the person from an audience, deleting the contact or importing the address again: every broadcast and automation email skips them, while ordinary mail and replies still reach them. q is one whole address, matched exactly; source keeps one way of unsubscribing. Only one the team recorded by hand can be taken back. One page at a time: when more follow, the last line gives a cursor to pass back for the next page.
Inputs
qstring- Up to 320 characters
sourcestring- One of
"link""one_click""manual""complaint""import" limitinteger- At least 1At most 100
cursorstring
Also available in
addUnsubscribe
Record that somebody asked for no more marketing mail, when they asked by phone, in a reply or anywhere else. Their contact is unsubscribed from every audience at once, the automations sending to them end, and no broadcast or automation email goes to the address again. Ordinary mail and replies still reach them. Recording an address that is already there changes nothing.
Inputs
emailstringRequired- Up to 320 charactersFormat
email
Also available in
removeUnsubscribe
Take back an unsubscribe the team recorded by hand, for one recorded by mistake, so marketing mail may go to the address again and the audiences it unsubscribed are subscribed again. One the person made themselves, a complaint or one brought from another provider is refused: only the person can subscribe again, through a sign-up they confirm or Subscribe again on the unsubscribe page.
Inputs
emailstringRequired- Up to 320 charactersFormat
email
Also available in
- API
DELETE /suppressions/unsubscribes/{email}- TypeScript
nextmail.suppressions.removeUnsubscribe()- Python
suppressions.remove_unsubscribe()- Ruby
suppressions.remove_unsubscribe- PHP
suppressions->removeUnsubscribe- Go
Suppressions.RemoveUnsubscribe- Java
suppressions().removeUnsubscribe- C#
Suppressions.RemoveUnsubscribeAsync