Docs
Do-not-contact

Add a do-not-contact entry

POSThttps://api.norreach.app/v1/suppressions

Blocks every send to an email address, a phone number, a company domain (and its sub-domains) or a LinkedIn URL — for automated outreach and replies alike. Adding an entry that already exists returns it (200).

⚠ suppressions:writeRole must allow: settings.complianceOperation id: create_suppression
POST/suppressions
curl -X POST "https://api.norreach.app/v1/suppressions" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "email",
  "value": "no.thanks@example.com",
  "reason": "do_not_contact"
}'
Add a do-not-contact entry
{
  "id": "3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6b",
  "object": "suppression",
  "kind": "email",
  "value": "no.thanks@example.com",
  "reason": "do_not_contact",
  "created_at": "2026-11-04T09:12:33.120Z"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope suppressions:write. API keys and scopes

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

kindenumrequired
One of:emailphonedomainlinkedin
valuestringrequired
reasonenum

Email and phone entries only. Defaults to manual.

One of:manualdo_not_contactunsubscribedcomplaintbounced

Response

201application/json— Add a do-not-contact entry

idstring (uuid)required

An id (UUID).

object"suppression"required
kindenumrequired

erased = a person whose data was erased; only a fingerprint is kept, so value is null.

One of:emailphonedomainlinkedinerased
valuestring | nullrequired
reasonstring | nullrequired
created_atstringrequired

RFC 3339 UTC timestamp with milliseconds.

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403role_forbiddenThe key's creator's role can't do this.
409idempotency_in_progressA request with this Idempotency-Key is still running.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.