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

Request

Base URL
https://api.arkhq.io/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/arkhq-io/apis/ark-email-api/docs/tenants/:tenantId/suppressions/post.ts
A function with typed inputs. Its response is checked against the schema.

tenantIdstring required

The tenant ID

addressstring email required

Email address to suppress

reasonstring nullable

Reason for suppression (accepts null)

{
  "reason": "unsubscribed"
}

Address suppressed

successtrue required

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