Suppression

Returns a suppression list since provided date.

post/suppression/list.json

Request

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

Request body

causestring

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;<li>blocked - sending to the email is prohibited by administration of UniOne.</ul>We may add some new causes in the future.

sourcestring

Source of email being suppressed. One of:<ul><li>user - suppressed by user with suppression/set;<li>system - sending to the email is prohibited by system, for example due to multiple hard bounces;<li>subscriber - the recipient reported spam or unsubscribed in the previous emails.</ul>

start_timestring utc-date

Date in the format YYYY-MM-DD hh:mm:ss to get suppression list from the "start_time" to the present day. Ignored if "cursor" is not empty.

cursorstring

The parameter indicates from which position the selection is to be started. Must be empty or omitted for the first data chunk. In order to get subsequent chunks, you must set the "cursor" parameter in your request, using the value received in response to the previous request.

limitinteger

Limits the number of records to be returned at one time, default is 50.

Example request

{
  "cause": "unsubscribed",
  "source": "user",
  "start_time": "2020-10-14 17:00:00",
  "cursor": "Ajfb6Hvdkn3hdhhvG57xbdufhG5",
  "limit": 50
}

Response

Returns a suppression list since provided date.

status'success' required

"success" string

cursorstring required

The parameter indicates from which position the selection is to be started. Must be empty or omitted for the first data chunk. In order to get subsequent chunks, you must set the "cursor" parameter in your request, using the value received in response to the previous request.

Example response

{
  "suppressions": [
    {
      "cause": "unsubscribed",
      "source": "user",
      "created": "2021-12-19 10:15:49"
    }
  ],
  "cursor": "Ajfb6Hvdkn3hdhhvG57xbdufhG5"
}

Changes

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