Get suppression list info

Description

Retrieves suppression list details.

Request URL

Method: POST

https://example.com/api/v1.1/suppresses/get

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format. By default – json
id	int	1	Yes	Suppression list ID

Request example

JSON

{
    "id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<xml>
  <id>1</id>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

Response example

JSON

{
    "data": {
        "id": 1,
        "is_global": true,
        "name": "Global suppress list"
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<result>
  <data>
    <id>1</id>
    <is_global>true</is_global>
    <name>Global suppress list</name>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</result>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Suppression list ID
name	string	Suppression list name
is_global	bool	Global suppression list flag