Suppression

Suppress an address

Permission required: subscribers:write. The matching subscriber, if there is one, moves to unsubscribed in the same operation. Without reason, the entry is manual and refuses everything, individual emails included; unsubscribe only refuses campaigns, automations and sends carrying unsubscribe_url. An entry already bounce, complaint or manual is never downgraded to unsubscribe.

No endpoint removes an address from this list, and that is deliberate: it is the one action that suspends a sending capability. It is done by hand, in your Mailcheer workspace.

post/api/v1/suppression

Request

  • Base URL: https://mailcheer.com
  • URL: https://mailcheer.com/api/v1/suppression
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

emailstring email required
reason'unsubscribe' | 'bounce' | 'complaint' | 'manual'

Response

Suppressed.

object'suppression'
emailstring
reason'unsubscribe' | 'bounce' | 'complaint' | 'manual'
scope'organization' | 'platform'
created_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.