add_suppressions
Add recipients to the API Platform (Email API / SMTP) suppression list so they are rejected on future API Platform sends. It does NOT stop Marketing Platform campaigns: to stop campaigns reaching an address, unsubscribe the contact (update_contact) or import it as suppressed in the panel. Scopes: global (default) blocks every API Platform send; marketing blocks only PROMOTIONAL Email API messages (metadata campaignType PROMOTIONAL), NOT Marketing Platform campaigns; transactional blocks only transactional (non-promotional) API Platform messages. The request is all-or-nothing: an invalid address rejects the whole batch. This blocks future mail to those addresses — confirm with the user first. Set dry_run: true to validate without changing anything.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | Scope for the whole batch: global (default, every API Platform send), marketing (promotional Email API messages only, not Marketing Platform campaigns), or transactional | |
| emails | Yes | Email addresses to suppress | |
| confirm | No | Must be true to make the change. Leave it out first to get a preview, show it to the user, and ask them to confirm | |
| dry_run | No | Validate the addresses and show what would be suppressed without changing anything |