Email Suppressions

Suppress an address

Adds an address to the suppression list so no future send reaches it. Adding an address that is already suppressed returns the existing entry unchanged, rather than rewriting why it was suppressed.

reason accepts manual (default) and unsubscribed. bounced and complained are set only by the provider's delivery events, so the record of why an address bounced stays truthful.

post/email/suppressions

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/email/suppressions
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Request body

addressstring required
reason'manual' | 'unsubscribed'

Why the address is suppressed. Defaults to manual. Bounces and complaints are recorded automatically from delivery events and cannot be set here.

metadataobject

Response

Address suppressed

objectstring required
idstring required
addressstring required
reason'bounced' | 'complained' | 'unsubscribed' | 'manual' required
email_messagestring nullable required
metadataobject required
created_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.