Добавить один или несколько email-адресов в стоп-список

Описание

Добавить один или несколько email-адресов в стоп-список. Использует JSON структуры.

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
emails	JSON array	["john@example.com"]	Да	Список из email-адресов
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
id	int	1	Да	Идентификатор стоп-списка

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

JSON

{
    "emails": [
        "john@example.com"
    ],
    "id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <emails>john@example1.com</emails>
  <emails>john@example2.com</emails>
  <id>1</id>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

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

JSON

{
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 3,
    "total_duplicated": 0,
    "total_imported": 3,
    "total_invalid": 0
}

XML

<result>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <total_count>3</total_count>
  <total_duplicated>0</total_duplicated>
  <total_imported>3</total_imported>
  <total_invalid>0</total_invalid>
</result>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
total_count	int	Всего адресов
total_duplicated	int	Адреса, добавленные в стоп-список ранее
total_imported	int	Адресов добавлено
total_updated	int	Адресов обновлено (при совпадении)