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
Filter entries to a specific suppression group ID.
enum<string>
Filter entries by suppression reason. One of UNSUBSCRIBE, BOUNCE, COMPLAINT, or MANUAL.
integer
Page number for pagination. Must be 1 or greater. Defaults to 1.
integer
Number of results per page. Must be between 1 and 100. Defaults to 20.
Free-text search string matched against the email address or other entry fields.
string
ISO 8601 timestamp. Returns only entries created on or after this date.
string
ISO 8601 timestamp. Returns only entries created on or before this date.
string
Filter entries to a specific email address.
boolean
When true, returns only entries belonging to global suppression groups.

Response

Suppression entries retrieved successfully
boolean
Example: true
object