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

Изменить параметры почтового ящика

Запрос позволяет редактировать параметры почтового ящика: пароль, имя, фамилию пользователя и т. д.

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

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

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

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

Описание

ПДД-токен.

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

Тип

Строка

Значение

Имя домена.

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

Тип

Строка

Значение

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

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

]no-highlight]
=<email-адрес или логин почтового ящика>|uid
[no-highlight[

Тип

Число

Значение

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

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

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

]no-highlight]
=<идентификатор почтового ящика>) [&password
[no-highlight[

Тип

Строка

Значение

Новый пароль пользователя.

Пароль:

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

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

]no-highlight]
=<новый пароль>] [&iname
[no-highlight[

Тип

Строка

Значение

Имя пользователя.

]no-highlight]
=<имя>] [&fname
[no-highlight[

Тип

Строка

Значение

Фамилия пользователя.

]no-highlight]
=<фамилия>] [&enabled
[no-highlight[

Тип

Строка

Значение

Статус работы почтового ящика.

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

  • yes — почтовый ящик работает.
  • no — почтовый ящик заблокирован (например, из-за рассылки спама или подозрения на взлом).

]no-highlight]
=<статус работы почтового ящика>] [&birth_date
[no-highlight[

Тип

Строка

Значение

Дата рождения пользователя в формате YYYY-MM-DD.

]no-highlight]
=<дата рождения>] [&sex
[no-highlight[

Тип

Число

Значение

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

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

  • 0 — не указан.
  • 1 — мужской.
  • 2 — женский.

]no-highlight]
=<пол>] [&hintq
[no-highlight[

Тип

Строка

Значение

Секретный вопрос.

]no-highlight]
=<секретный вопрос>] [&hinta
[no-highlight[

Тип

Строка

Значение

Ответ на секретный вопрос.

]no-highlight]
=<ответ на секретный вопрос>]

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

login Строка

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

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

uid Число

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

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

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

Необязательные
password Строка

Новый пароль пользователя.

Пароль:

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

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

iname Строка

Имя пользователя.

fname Строка

Фамилия пользователя.

enabled Строка

Статус работы почтового ящика.

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

  • yes — почтовый ящик работает.
  • no — почтовый ящик заблокирован (например, из-за рассылки спама или подозрения на взлом).

birth_date Строка

Дата рождения пользователя в формате YYYY-MM-DD.

sex Число

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

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

  • 0 — не указан.
  • 1 — мужской.
  • 2 — женский.

hintq Строка

Секретный вопрос.

hinta Строка

Ответ на секретный вопрос.

POST /api2/registrar/email/edit
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».

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

]no-highlight]
=<email-адрес или логин почтового ящика>|uid
[no-highlight[

Тип

Число

Значение

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

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

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

]no-highlight]
=<идентификатор почтового ящика>) [&password
[no-highlight[

Тип

Строка

Значение

Новый пароль пользователя.

Пароль:

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

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

]no-highlight]
=<новый пароль>] [&iname
[no-highlight[

Тип

Строка

Значение

Имя пользователя.

]no-highlight]
=<имя>] [&fname
[no-highlight[

Тип

Строка

Значение

Фамилия пользователя.

]no-highlight]
=<фамилия>] [&enabled
[no-highlight[

Тип

Строка

Значение

Статус работы почтового ящика.

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

  • yes — почтовый ящик работает.
  • no — почтовый ящик заблокирован (например, из-за рассылки спама или подозрения на взлом).

]no-highlight]
=<статус работы почтового ящика>] [&birth_date
[no-highlight[

Тип

Строка

Значение

Дата рождения пользователя в формате YYYY-MM-DD.

]no-highlight]
=<дата рождения>] [&sex
[no-highlight[

Тип

Число

Значение

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

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

  • 0 — не указан.
  • 1 — мужской.
  • 2 — женский.

]no-highlight]
=<пол>] [&hintq
[no-highlight[

Тип

Строка

Значение

Секретный вопрос.

]no-highlight]
=<секретный вопрос>] [&hinta
[no-highlight[

Тип

Строка

Значение

Ответ на секретный вопрос.

]no-highlight]
=<ответ на секретный вопрос>]

Заголовки:

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

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

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

Имя домена.

login Строка

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

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

uid Число

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

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

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

Необязательные
password Строка

Новый пароль пользователя.

Пароль:

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

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

iname Строка

Имя пользователя.

fname Строка

Фамилия пользователя.

enabled Строка

Статус работы почтового ящика.

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

  • yes — почтовый ящик работает.
  • no — почтовый ящик заблокирован (например, из-за рассылки спама или подозрения на взлом).

birth_date Строка

Дата рождения пользователя в формате YYYY-MM-DD.

sex Число

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

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

  • 0 — не указан.
  • 1 — мужской.
  • 2 — женский.

hintq Строка

Секретный вопрос.

hinta Строка

Ответ на секретный вопрос.

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

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

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

{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

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

Тип значения

Строка

Описание

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

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

Тип значения

Число

Описание

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

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

Тип значения

Строка

Описание

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

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

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

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

Тип значения

Объект

Описание

Параметры почтового ящика.

]no-highlight]
": { "uid
[no-highlight[

Тип значения

Число

Описание

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

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

Тип значения

Строка

Описание

Имя пользователя.

]no-highlight]
": "{имя пользователя}", "sex
[no-highlight[

Тип значения

Число

Описание

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

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

  • 0 — не указан.
  • 1 — мужской.
  • 2 — женский.

]no-highlight]
": "{пол пользователя}", "ready
[no-highlight[

Тип значения

Строка

Описание

Готовность к работе почтового ящика.

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

  • yes — пользовательское соглашение принято, ящик готов к использованию.
  • no — пользовательское соглашение не принято, ящик не готов к использованию.

]no-highlight]
": "{готовность к работе почтового ящика}", "hintq
[no-highlight[

Тип значения

Строка

Описание

Секретный вопрос.

]no-highlight]
": "{любимое блюдо домашнего питомца ???}", "aliases
[no-highlight[

Тип значения

Массив

Описание

Список алиасов почтовых адресов.

]no-highlight]
": [ "{имя алиаса}", ... ], "enabled
[no-highlight[

Тип значения

Строка

Описание

Статус работы почтового ящика.

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

  • yes — почтовый ящик работает.
  • no — почтовый ящик заблокирован (например, из-за рассылки спама или подозрения на взлом).

]no-highlight]
": "{статус работы почтового ящика}", "maillist
[no-highlight[

Тип значения

Строка

Описание

Признак рассылки.

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

  • yes — почтовый ящик является рассылкой.
  • no — почтовый ящик не является рассылкой.

]no-highlight]
": "{признак рассылки}", "fname
[no-highlight[

Тип значения

Строка

Описание

Фамилия пользователя.

]no-highlight]
": "{фамилия пользователя}", "birth_date
[no-highlight[

Тип значения

Строка

Описание

Дата рождения пользователя в формате YYYY-MM-DD.

]no-highlight]
": "{дата рождения пользователя}", "login
[no-highlight[

Тип значения

Строка

Описание

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

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

Тип значения

Строка

Описание

ФИО пользователя.

]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 — запрос выполнен с ошибкой.

account Объект

Параметры почтового ящика.

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

Ключи объекта account
login Строка

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

uid Число

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

enabled Строка

Статус работы почтового ящика.

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

  • yes — почтовый ящик работает.
  • no — почтовый ящик заблокирован (например, из-за рассылки спама или подозрения на взлом).

fio Строка

ФИО пользователя.

aliases Массив

Список алиасов почтовых адресов.

fname Строка

Фамилия пользователя.

iname Строка

Имя пользователя.

birth_date Строка

Дата рождения пользователя в формате YYYY-MM-DD.

sex Число

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

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

  • 0 — не указан.
  • 1 — мужской.
  • 2 — женский.

hintq Строка

Секретный вопрос.

ready Строка

Готовность к работе почтового ящика.

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

  • yes — пользовательское соглашение принято, ящик готов к использованию.
  • no — пользовательское соглашение не принято, ящик не готов к использованию.

maillist Строка

Признак рассылки.

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

  • yes — почтовый ящик является рассылкой.
  • no — почтовый ящик не является рассылкой.