Sending & observability

email_add_suppression

Manually suppress an address.

write email_add_suppression

Manually suppress an address. A manual suppression (default) blocks ALL sends to it in this project. Pass reason unsubscribe with a topic to record a per-topic opt-out that blocks only that lifecycle stream (transactional receipts/resets still deliver); omit topic on an unsubscribe for a global lifecycle opt-out.

Parameters

ParameterTypeRequiredDescription
emailstringYes
reasonmanual | unsubscribeNo
topicstringNoScope an unsubscribe to one subscription topic (e.g. 'newsletter'). Only valid with reason unsubscribe.
notestringNo
projectIdstringNoTarget company (project id). Org-scoped tokens only; call email_list_projects first.

On this page