Suppressions

Add suppression

Suppress an address, e.g. an opt-out collected outside SNDR. Returns 201; an address that is already suppressed keeps its original reason.

POSThttps://api.sndr.sh/v1/suppressions

Add suppression

curl -X POST 'https://api.sndr.sh/v1/suppressions' \
  -H "Authorization: Bearer $SNDR_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"address": "optout@example.com", "detail": "Unsubscribed via support ticket"}'

201Created

{
  "address": "optout@example.com",
  "reason":  "manual"
}

Authorization

Authorizationstringheaderrequired

Bearer followed by your API key. Needs the send scope.

Body

application/json

addressstringrequired

Email address to suppress. Stored lowercase.

reasonstring

Why it is suppressed. Defaults to manual.

detailstring

Optional note shown in the list.

Errors

401unauthenticatedMissing or invalid API key.

400invalid_requestBody is not valid JSON, or address is missing or not an email.

403insufficient_scopeThe API key is missing the send scope.