Подписать на рассылку

Запрос позволяет добавить почтовый ящик в рассылку.

Ограничение. Вы можете подписать на рассылку не более 10 000 почтовых ящиков.

Как рассылку, так и подписчика можно задать с помощью одного из двух атрибутов: email-адреса или идентификатора. Идентификатор рассылки можно получить в ответе на запрос Получить рассылки домена, идентификатор подписчика — в ответе на запрос Получить список почтовых ящиков.

  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

Синтаксис запроса

Запрос следует отправлять по протоколу HTTPS с помощью метода POST.

POST /api2/admin/email/ml/subscribe
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
...

domain=<имя домена>
&(maillist=<email-адрес или логин рассылки>|maillist_uid=<идентификатор рассылки>)
&(subscriber=<email-адрес подписчика>|subscriber_uid=<идентификатор подписчика>)
[&can_send_on_behalf=<статус подписчика>]

Заголовки:

Название Описание
PddToken

ПДД-токен.

Параметры:

Параметр Тип Значение
Обязательные
domain Строка

Имя домена.

maillist Строка

Email-адрес рассылки в формате «login@domain.ru» или «login».

В запросе нужно передать только один из параметров: maillist или maillist_uid.

maillist_uid Число

Идентификатор рассылки.

Значение идентификатора можно получить в ответе на запрос Получить рассылки домена.

В запросе нужно передать только один из параметров: maillist или maillist_uid.

subscriber Строка

Email-адрес подписчика.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

subscriber_uid Число

Идентификатор подписчика.

Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

Необязательные
can_send_on_behalf Строка
Статус подписчика. Допустимые значения:
  • yes — подписчик может отправлять письма от имени рассылки. Такой подписчик может указать email-адрес рассылки в поле письмо от (в интерфейсе почты).
  • no — подписчик не может отправлять письма с email-адреса рассылки.

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

POST /api2/admin/email/ml/subscribe HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321&can_send_on_behalf=yes
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321' 'https://pddimp.yandex.ru/api2/admin/email/ml/subscribe'

Структура ответа

{
  "domain": "{имя домена}", 
  "maillist": "{email-адрес рассылки}", 
  "uid": "{идентификатор рассылки}",
  "subscriber": "{email-адрес подписчика}", 
  "success": "{статус выполнения запроса}"
}
Название Тип значения Описание
domain Строка

Имя домена.

maillist Строка

Email-адрес рассылки.

uid Число

Идентификатор рассылки.

subscriber Строка

Email-адрес подписчика.

success Строка

Статус выполнения запроса.

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
error Строка

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:
  • unknown — произошел временный сбой или ошибка работы API (повторите запрос позже).
  • no_token (no_domain, no_ip ) — не передан обязательный параметр.
  • bad_domain — имя домена не указано или не соответствует RFC.
  • prohibited — запрещенное имя домена.
  • bad_token (bad_login, bad_passwd) — передан неверный ПДД-токен (логин, пароль).
  • no_auth — не передан заголовок PddToken.
  • not_allowed — пользователю недоступна данная операция (он не является администратором этого домена).
  • blocked — домен заблокирован (например, за спам и т.п.).
  • occupied — имя домена используется другим пользователем.
  • domain_limit_reached — превышено допустимое количество подключенных доменов (50).
  • no_reply — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.