Get Suppression Lists

GET 
/suppression

Retrieves a list of all suppression lists in your account

Use this endpoint to view details of each suppression list, including names, and the number of suppressed customer email addresses, helping you manage and monitor opt-outs effectively.

Request

Responses

200

successful operation

application/json

Schema

Schema

suppressions object[]
Array [
id int64
name string
type string
Possible values: [EMAIL, MD5, SHA256]
scope string
Possible values: [LOCAL, GLOBAL]
fileProcessStatus string
Possible values: [UPLOADED, IN_PROGRESS, COMPLETED, FAILURE]
numberOfMembers int64
Total number of suppressed email addresses
]

Example (from schema)

{
  "suppressions": [
    {
      "id": 1,
      "name": "Suppression List 1",
      "type": "EMAIL",
      "scope": "LOCAL",
      "fileProcessStatus": "COMPLETED",
      "numberOfMembers": 100
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Some error message"
}

401

API key is missing or invalid

405

Method Not Allowed

Loading...