Suppressions

Add a suppression

POST
/api/v1/suppressions

Adds an address to the do-not-send list. Requires a write-scope key.

Authorization

bearerAuth write
headerAuthorizationBearer <token>

An API key from the dashboard under Settings → API keys, sent as Authorization: Bearer aem_….

Authorization has two independent axes.

The scope is ranked — a key satisfies any requirement at or below its own tier:

  • read — see messages, contacts and metrics. Changes nothing, and cannot send.
  • write — everything read does, plus managing templates, contacts, automations, segments and suppressions. This is what editing a template needs.
  • admin — everything write does, plus sending configuration: domains, senders, webhook registration, kill switch, daily cap, brand.

There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.

The approval grant (can_approve) is a separate boolean, not a rung. Delivering mail to a real inbox needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.

Give your application the lowest tier that works. Most need write and the grant — the dashboard mints that combination as Send + manage; Manage only is the same rung with the grant withheld.

Scope: write

Header Parameters

Idempotency-Key?string

Makes a retry safe (1–256 chars, kept 24 hours). The same key with the same body replays the first success with Idempotency-Replay: true; the same key with a different body, or while the first request is still running, is 409 conflict. A failed request releases its key. Use a value tied to the thing you are creating, e.g. onboarding/user_42.

Length1 <= length <= 256

Request Body

application/json
  1. body
email*string

Address to suppress.

reason?string

Defaults to manual. invalid is not settable here — it's written only by address verification, like bounce/complaint are written only by provider webhooks.

Value in"unsubscribe""bounce""complaint""manual"
note?string

Free-text note.

Response Body

Suppressed.

application/json
  1. response
email?string
suppressed?boolean
Example Request
curl -X POST 'https://sendandretain.com/api/v1/suppressions' \  -H 'Content-Type: application/json' \  -d '{  "email": "[email protected]",  "reason": "manual",  "note": "hard bounce from import"}'
Example Response
{  "email": "string",  "suppressed": true}