Get Suppression List

GET 
/suppression/:id

Retrieves all details of a specific suppression list

Use this endpoint to view information such as the list name and the number of suppressed customer email addresses enabling precise management of suppressed recipients.

Request

Path Parameters

id int64required

ID of the suppression list

Responses

200

successful operation

application/json

Schema

Schema

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)

{
  "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

404

Suppression list not found

405

Method Not Allowed

Loading...