campaigns

POST `/v1/campaigns/suppressions`

Add an address to the suppression list.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/campaigns/suppressions \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string>, "reason": <string<unsubscribed, bounced, complained, staff_blocked>> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

`unsubscribed` applies to your own campaigns. `bounced`, `complained` and `staff_blocked` are facts about the ADDRESS and are stored platform-wide whatever scope you send them under — continuing to mail a hard bounce damages delivery for every other customer sending from the same domain. Idempotent on `(scope, address, purpose)`.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`string`	No	—

Request body

Name	Type	Required	What it is
`email`	`string`	Yes	—
`reason`	`string<unsubscribed, bounced, complained, staff_blocked>`	Yes	—
`note`	`string`	No	—

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`email`	`string`	Yes	—
`reason`	`string`	Yes	—

Errors this endpoint can return

401 · 403 · 422