Skip to main content
POST
/
suppressions
/
bulk
Bulk add to suppression list
curl --request POST \
  --url https://api.arkhq.io/v1/suppressions/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "suppressions": [
    {
      "address": "[email protected]",
      "reason": "<string>"
    }
  ]
}
'
{
  "success": true,
  "data": {
    "totalRequested": 123,
    "added": 123,
    "updated": 123,
    "failed": 123
  },
  "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
suppressions
object[]
required
Maximum array length: 1000

Response

Bulk operation result

success
boolean
required
data
object
required
meta
object
required