Suppressions

List suppressions

Return suppressed addresses for the current account. Suppressed recipients are blocked before sending. A suppression with scope marketing blocks marketing email only; scope all blocks every send.

get/v1/suppressions

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/suppressions
  • Auth: HTTP bearer

Query parameters

qstring

Search by suppressed email address

reason'all' | 'hard_bounce' | 'complaint' | 'manual' | 'unsubscribe'

Filter by suppression reason

limitinteger

Number of suppressions to return

Response

List of suppressions

objectstring required
has_moreboolean required
pageinteger
page_sizeinteger
filtered_totalinteger

Suppressions matching q and reason

totalinteger

Every suppression of the team

hard_bouncesinteger
complaintsinteger
manualinteger

Example response

{
  "object": "list",
  "data": [
    {
      "object": "suppression",
      "id": "clx_suppression123",
      "email": "blocked@example.com",
      "reason": "hard_bounce",
      "source": "ses",
      "scope": "all",
      "bounce_type": "permanent"
    }
  ],
  "page": 1,
  "page_size": 50,
  "filtered_total": 412,
  "total": 412,
  "hard_bounces": 388,
  "complaints": 19,
  "manual": 5
}

Changes

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