Check if domain is suppressed

Description

Check if an email domain is in a suppression list.

Request URL

Method: POST

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

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
domain	string	"example.com"	Yes	Email domain

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "domain": "example.com",
    "id": 1   
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <domain>example.com</domain>
  <id>1</id>
</xml>

Response example

JSON

{
    "error": 0,
    "error_text": "Successful operation",
    "matched": true
}

XML

<xml>
    <domain_matched>true</domain_matched>
    <email_matched>false</email_matched>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <matched>true</matched>
    <phone_matched>false</phone_matched>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
matched	bool	true, if domain is on the suppression list