API · Suppressions

Add Suppression

Suppress an email address to prevent sending to it (requires full access). The address is normalized and the suppression origin is manual.

POST/suppressionsFull access

Request parameters

Parameter	Type	Description
`Idempotency-Key` header · optional	`string` 1–256 characters	Makes the request safe to retry. See Idempotency.
`email` body · required	`string`	Email address to suppress.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X POST "$OPENSEND_BASE_URL/suppressions" \
  -H "Authorization: Bearer $OPENSEND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"email":"you@example.net"}'

Response

201 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "suppression",
  "id": "e169aa45-1ecf-4183-9955-b1499d5701d3"
}

Behavior and errors

Use a suppression ID or URL-encoded email for retrieval and removal. Addresses are trimmed and lowercased. Older automatic entries can have source_id: null. See suppression management.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.