Docs
kirora.ioGet started
Suppressions overviewMenu
On this page

API reference

Suppressions

A suppression is a block on an email address, held whether or not a contact has it, with its reason. A bounce (bounced) or a spam complaint about a transactional message (complained_transactional) stops all email, transactional included. An unsubscribe (unsubscribed), a spam complaint about marketing mail (complained) and a block you add (manual, imported) stop marketing only: receipts, password resets and other transactional email still send.

Endpoints

EndpointRequest
List suppressed email addressesGET /v1/suppressions
Add suppressed email addressesPOST /v1/suppressions
Delete suppressed email addressesPOST /v1/suppressions/delete

The Suppression object

Suppression example
{
  "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
  "channel": "email",
  "address": "address_example",
  "reason": "manual",
  "removable": true,
  "createdAt": "2030-03-14T09:30:00Z"
}
idstringrequired

uuid

channel"email"required
addressstringrequired
reasonstringrequired

Why the address is blocked: manual (blocked by a person), imported (added through addSuppressions), unsubscribed, bounced, complained (marked as spam on marketing mail) or complained_transactional (marked as spam on a transactional message).

one of manual, imported, unsubscribed, bounced, complained, complained_transactional

removablebooleanrequired

True for manual and imported; bounces, complaints and unsubscribes cannot be removed.

createdAtstringrequired

date-time