Suppression

An email address suppressed from receiving emails due to bounces, blocks, spam reports, or manual suppression.

Properties

• id (string): Unique identifier for the suppression record.
• email ([[EmailAddress]]): The suppressed email address.
• type (string): Suppression type (bounce, block, spam, unsubscribe, invalid).
• reason (string): Reason for suppression.
• source (string): How suppression was created (bounce, user, admin, api).
• groupId (string): Unsubscribe group ID if applicable.
• groupName (string): Unsubscribe group name if applicable.
• created (number): Timestamp when suppression was created (Unix timestamp).
• metadata (object): Set of key-value pairs for storing additional information.

Actions

create

Add email to suppression list.

Input: [[Suppression]]
Output: [[Suppression]]

delete

Remove email from suppression list.

Input: [[Suppression]]
Output: [[Suppression]]

search

Search suppressions by email or type.

Input: [[SuppressionSearchQuery]]
Output: [[Suppression]][]

export

Export suppression list.

Input: [[SuppressionExportRequest]]
Output: [[SuppressionExport]]

Events

• created: Triggered when an email is suppressed.
• deleted: Triggered when a suppression is removed.