Suppressions

List suppressed email addresses

Returns a paginated list of email addresses that have been suppressed for your organization. Addresses are suppressed automatically on hard bounces, complaints and repeated soft bounces, or by importing a suppression list into an audience. A complaint about a newsletter has scope marketing and blocks newsletter sends only; every other entry has scope all and blocks every send. A soft-bounce entry expires 30 days after it is created, unless the address had already been paused once.

get/suppressions

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/suppressions
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Query parameters

cursorstring

Opaque pagination cursor returned by the same list operation. Send it unchanged; do not parse, modify, or fabricate it.

limitinteger

Number of items to return (1-100, default 25).

scope'all' | 'marketing'

Return only entries with this scope.

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Paginated list of suppressed addresses.

Changes

No recorded changes to this operation across all 1 revision of this API.