Skip to main content
GET
/
tenants
/
{tenantId}
/
suppressions
/
{email}
Check if address is suppressed
curl --request GET \
  --url https://api.arkhq.io/v1/tenants/{tenantId}/suppressions/{email} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "suppressed": true,
    "address": "jsmith@example.com",
    "reason": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Path Parameters

tenantId
string
required

The tenant ID

email
string<email>
required

Email address (URL-encoded)

Response

Suppression status

success
boolean
required
data
object
required
meta
object
required