Добавить заместителя администратора домена

Внимание. Сервис Яндекс Почта для домена больше не поддерживается. API Почты для домена прекратит работу с 1 апреля 2023 года. С 24 марта доступность сервиса будет ограничена.

Для управления доменами, пользователями и организациями используйте сервис Яндекс 360 для бизнеса.

Документация API 360

Заместитель администратора домена может распоряжаться почтовыми ящиками, но не может управлять самим доменом и его настройками.

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

Ограничение. Заместителем администратора можно назначить только пользователя, имеющего независимую учетную запись на Яндексе (учетная запись вида <login>@yandex.ru).
  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

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

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

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

domain=<имя домена>
&login=<логин заместителя администратора>

Заголовки:

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

ПДД-токен.

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

ПДД-токен.

Параметры:

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

Имя домена.

login Строка

Логин пользователя на Яндексе.

Внимание. Заместителем могут быть только зарегистрированные пользователи Яндекса (имеющие адрес вида <login>@yandex.ru). Не следует указывать в качестве логина имя одного из почтовых ящиков вашего домена.
Параметр Тип Значение
Обязательные
domain Строка

Имя домена.

login Строка

Логин пользователя на Яндексе.

Внимание. Заместителем могут быть только зарегистрированные пользователи Яндекса (имеющие адрес вида <login>@yandex.ru). Не следует указывать в качестве логина имя одного из почтовых ящиков вашего домена.

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

POST /api2/admin/deputy/add HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&login=mylogin
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&login=mylogin' 'https://pddimp.yandex.ru/api2/admin/deputy/add'

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

{
  "domain": "{имя домена}", 
  "success": "{статус выполнения запроса}", 
  "error": "{код ошибки}"
}
Название Тип значения Описание
domain Строка

Имя домена.

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

Имя домена.

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