Skip to main content
POST

Authorizations

string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

string[]
required
An array of valid email addresses to suppress. Must contain at least one address.
string
The ID of the suppression group to add the addresses to. Omit to add to the default group.
enum<string>
The reason for suppression. Stored on each entry for reporting. One of UNSUBSCRIBE, BOUNCE, COMPLAINT, or MANUAL.
boolean
When true, adds the entries to the global suppression list rather than a project-specific group.

Response

Emails suppressed successfully
boolean
Example: true
object