Перейти к основному содержимому

Проверить email-адрес в стоп-списке

Описание

Проверить email-адрес в стоп-списке.

URL-адрес

Метод: POST

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

Параметры запроса

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
emailstring"john@example.com"ДаEmail-адрес
formatstring"json"НетФормат возвращаемых данных
(по умолчанию – "json")
idint1ДаИдентификатор стоп-списка

Пример запроса

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

Пример ответа

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

Возвращаемые параметры

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
domain_matchedbooltrue, если домен найден в списке доменов
email_matchedbooltrue, если домен найден в списке email-адресов
matchedbooltrue, если email найден в списке email-адресов или доменах