Suppressions

Suppress an address

Block one address ({ email }) or up to 1,000 at once ({ emails: [...] }) from receiving any future sends from your workspace. The operation is idempotent — re-suppressing an existing address returns 200 rather than a conflict. The bulk form returns an { object: "list", added, skipped, total } summary. Suppression is the hard stop; to let recipients opt out of just one kind of email, use topics (see Create a topic). Undo with Un-suppress an address. Requires the suppressions:write capability.

post/suppressions

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/suppressions
  • Auth: HTTP bearer

Request body

emailstring
emailsstring[]
reason'manual' | 'import' | 'api'
notestring

Response

Already suppressed (single → the Suppression), or the bulk summary ({ object: "list", added, skipped, total }).

OR

Changes

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