Skip to main content
The API Key is your access card: each scope opens a door. For suppressions, there are only two — read and write.

​
In brief

  • suppressions:read — list and query entries.
  • suppressions:write — add, import, and remove.
  • Write does not require read on the same key, but admin integrations usually use both.
General guide: API keys. First use: Quick Start.

​
How to send the key

Alternative: x-api-key: sk_live_xxxxx.
Empty scopes on creation = ADMIN access (everything). In production, always restrict.

​
Ready-made combinations

Read only

suppressions:read

Write only

suppressions:write

Full administration

suppressions:read, suppressions:write

CRM + suppressions

contacts:read, suppressions:read, suppressions:write

​
Available scopes

List suppressions (GET /v1/suppressions) and query by ID (GET /v1/suppressions/{id}).
Add (POST /v1/suppressions), batch (POST /v1/suppressions/batch/add), remove by ID, by identity, and batch removal.

​
Common errors

Full catalog: Error responses.

​
Next steps