Check if email is suppressed

Description

Checks if an email address is in a suppression list.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
email	string	"john@example.com"	Yes	Email address to check
format	string	"json"	No	Response data format By default – json
id	int	1	Yes	Suppression list ID

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "email": "john@example.com",
    "id": 1   
}

XML

<xml>
  <email>john@example.com</email>
  <id>1</id>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

JSON

 
{
    "domain_matched": false,
    "email_matched": true,
    "error": 0,
    "error_text": "Successful operation",
    "matched": true,
    "phone_matched": false
}

XML

<xml>
    <domain_matched>false</domain_matched>
    <email_matched>true</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
domain_matched	bool	true, if email domain is on the suppressed domains list
email_matched	bool	true, if email domain is on the suppressed emails list
matched	bool	true, if email address is on the suppressed emails or domains list