Suppressions

Check if address is suppressed

Check if a specific email address is on the tenant's suppression list.

get/tenants/{tenantId}/suppressions/{email}

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/:email/get.ts
A function with typed inputs. Its response is checked against the schema.

tenantIdstring required

The tenant ID

emailstring email required

Email address (URL-encoded)

Suppression status

successtrue required

{
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}