Suppression

Adds an email address to the suppression list. You can always remove this address from the suppression list later using the [suppression/delete](#suppression-delete) method.

post/suppression/set.json

Request

Base URL: https://api.unione.io/en/transactional/api/v1
URL: https://api.unione.io/en/transactional/api/v1/suppression/set.json
Auth: API key in header X-API-KEY

Request body

emailstring email required

Email to add in suppression list.

causestring required

Cause of email being suppressed. One of:<ul><li>unsubscribed - email is unsubscribed;<li>temporary_unavailable - the email address is unavailable. This means that over the next three days sending to this address will return an error. Email may be temporarily unavailable due to several reasons, e.g.:<ol><li>a previous email has been rejected by the recipient's server for spam;<li>the recipient's mailbox is full or is not used;<li>recipient's domain does not accept mail;<li>sending server was rejected due to blacklisting;</ol><li>permanent_unavailable - the email address is permanently unavailable due to multiple hard bounces; <li>complained - the recipient reported spam in the previous emails;</ul>

createdstring utc-date-time

When suppression was created, in UTC timezone in "YYYY-MM-DD hh:mm:ss" format.

Example request

{
  "email": "email@example.com",
  "cause": "unsubscribed",
  "created": "2021-12-19 10:15:49"
}

Response

Email has been added to the suppression list.

status'success' required

"success" string

Changes

No recorded changes to this operation across all 1 revision of this API.