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

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

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

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

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

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

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

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

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

domain=<имя домена>
&(login=<email-адрес или логин почтового ящика>|uid=<идентификатор почтового ящика>)
[&password=<новый пароль>]
[&iname=<имя>]
[&fname=<фамилия>]
[&enabled=<статус работы почтового ящика>]
[&birth_date=<дата рождения>]
[&sex=<пол>]
[&hintq=<секретный вопрос>]
[&hinta=<ответ на секретный вопрос>]

Заголовки:


Название	Описание
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	Строка	Ответ на секретный вопрос.


Параметр	Тип	Значение
Обязательные
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: <ПДД-токен>
Authorization: OAuth <OAuth-токен>
...

domain=<имя домена>
&(login=<email-адрес или логин почтового ящика>|uid=<идентификатор почтового ящика>)
[&password=<новый пароль>]
[&iname=<имя>]
[&fname=<фамилия>]
[&enabled=<статус работы почтового ящика>]
[&birth_date=<дата рождения>]
[&sex=<пол>]
[&hintq=<секретный вопрос>]
[&hinta=<ответ на секретный вопрос>]

Заголовки:


Название	Описание
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	Строка	Ответ на секретный вопрос.


Параметр	Тип	Значение
Обязательные
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": "{имя домена}", 
  "login":"{email-адрес почтового ящика}", 
  "uid": "{идентификатор  почтового ящика}",     
  "success": "{статус выполнения запроса}",
  "account": 
  {
    "uid": "{идентификатор почтового ящика}", 
    "iname": "{имя пользователя}", 
    "sex": "{пол пользователя}", 
    "ready": "{готовность к работе почтового ящика}", 
    "hintq": "{любимое блюдо домашнего питомца ???}", 
    "aliases": 
    [
      "{имя алиаса}", 
      ...
    ],    
    "enabled": "{статус работы почтового ящика}", 
    "maillist": "{признак рассылки}", 
    "fname": "{фамилия пользователя}", 
    "birth_date": "{дата рождения пользователя}", 
    "login": "{email-адрес почтового ящика}", 
    "fio": "{ФИО пользователя}"
  } 
}

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


Название	Тип значения	Описание
`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` — почтовый ящик не является рассылкой.


Название	Тип значения	Описание
`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` — почтовый ящик не является рассылкой.