Sign in

v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB
Suppressions

Add to suppression list

Add an email address to the tenant's suppression list. The address will not receive any emails from this tenant until removed.

post/tenants/{tenantId}/suppressions

Path parameters

tenantIdstring required

The tenant ID

Request body

addressstring email required

Email address to suppress

reasonstring nullable

Reason for suppression (accepts null)

Example request

{
  "reason": "unsubscribed"
}

Response

Address suppressed

successtrue required

Example response

{
  "data": {
    "id": "789",
    "reason": "hard_bounce"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}