Добавить рассылку

Рассылка — почтовый адрес, к которому привязана группа почтовых ящиков. Письма, отправленные на адрес рассылки, будут доставлены в каждый из привязанных ящиков.

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

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

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

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

Для администратора
POST /api2/admin/email/ml/add
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
...

domain=<имя домена>
&maillist=<email-адрес или логин рассылки>

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

maillist Строка

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

Для регистратора
POST /api2/registrar/email/ml/add
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
Authorization: OAuth <OAuth-токен>
...

domain=<имя домена>
&maillist=<email-адрес или логин рассылки>

Заголовки:

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

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

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

Имя домена.

maillist Строка

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

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

POST /api2/admin/email/ml/add HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&maillist=newmaillist
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&maillist=newmaillist' 'https://pddimp.yandex.ru/api2/admin/email/ml/add'

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

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

Имя домена.

maillist Строка

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

uid Число

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

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 — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.