Suppression

Gets a reason and date of email suppression.

post/suppression/get.json

Request

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

Request body

emailstring email required

Email to get suppression details for.

all_projectsboolean

If a user has projects functionality enabled, he/she can pass all_projects=true to search in all projects' data.

Example request

{
  "email": "email@example.com"
}

Response

Method call has succeeded (but suppressions array can be empty if sending to email is not suppressed).

status'success' required

"success" string

emailstring email required

The email for which suppression details were requested.

Example response

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

Changes

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