Skip to main content
POST
/
suppressions
Add to suppression list
curl --request POST \
  --url https://api.arkhq.io/v1/suppressions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "[email protected]",
  "reason": "user requested removal"
}
'
{
  "success": true,
  "data": {
    "id": "789",
    "address": "[email protected]",
    "createdAt": "2023-11-07T05:31:56Z",
    "reason": "hard_bounce"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

Authorization
string
header
required

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

Authorization: Bearer YOUR_API_KEY

Body

application/json
address
string<email>
required

Email address to suppress

Minimum string length: 1
reason
string | null

Reason for suppression (accepts null)

Example:

"unsubscribed"

Response

Address suppressed

success
boolean
required
data
object
required
meta
object
required