Документация
API Яндекс.Почты для домена

Добавить почтовый ящик

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

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

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

POST /api2/admin/email/add
Host: pddimp.yandex.ru
PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> ... domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> &login
[no-highlight[

Тип

Строка

Значение

Email-адрес почтового ящика в формате «login@domain.ru» или «login».

]no-highlight]
=<логин почтового ящика> &password
[no-highlight[

Тип

Строка

Значение

Пароль пользователя.

Пароль:

  • не должен совпадать с логином;

  • должен содержать от 6 до 20 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : “ \ | , . < > / ?, не допускаются ~ и ).

]no-highlight]
=<пароль>

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

login Строка

Email-адрес почтового ящика в формате «login@domain.ru» или «login».

password Строка

Пароль пользователя.

Пароль:

  • не должен совпадать с логином;

  • должен содержать от 6 до 20 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : " \ | , . < > / ?, не допускаются ~ и ').

POST /api2/registrar/email/add
Host: pddimp.yandex.ru
PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> Authorization
[no-highlight[

Описание

OAuth-токен.

]no-highlight]
: OAuth <OAuth-токен> ... domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> &login
[no-highlight[

Тип

Строка

Значение

Email-адрес почтового ящика в формате «login@domain.ru» или «login».

]no-highlight]
=<логин почтового ящика> &password
[no-highlight[

Тип

Строка

Значение

Пароль пользователя.

Пароль:

  • не должен совпадать с логином;

  • должен содержать от 6 до 20 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : “ \ | , . < > / ?, не допускаются ~ и ).

]no-highlight]
=<пароль>

Заголовки:

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

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

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

Имя домена.

login Строка

Email-адрес почтового ящика в формате «login@domain.ru» или «login».

password Строка

Пароль пользователя.

Пароль:

  • не должен совпадать с логином;

  • должен содержать от 6 до 20 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : " \ | , . < > / ?, не допускаются ~ и ').

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

POST /api2/admin/email/add HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&login=newlogin&password=1234567890
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&login=newlogin&password=1234567890' 'https://pddimp.yandex.ru/api2/admin/email/add'
POST /api2/admin/email/add HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com&login=newlogin&password=1234567890
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'domain=domain.com&login=newlogin&password=1234567890' 'https://pddimp.yandex.ru/api2/admin/email/add'

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

{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "login
[no-highlight[

Тип значения

Строка

Описание

Email-адрес почтового ящика.

]no-highlight]
":"{email-адрес почтового ящика}", "uid
[no-highlight[

Тип значения

Число

Описание

Идентификатор почтового ящика.

]no-highlight]
": "{идентификатор почтового ящика}", "success
[no-highlight[

Тип значения

Строка

Описание

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

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}" }
{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "success
[no-highlight[

Тип значения

Строка

Описание

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

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}", "error
[no-highlight[

Тип значения

Строка

Описание

Код ошибки.

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

Возможные значения:

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

]no-highlight]
": "{код ошибки}" }
НазваниеТип значенияОписание
domain Строка

Имя домена.

login Строка

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