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

Удалить почтовый ящик

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

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

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

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

POST /api2/admin/email/del
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]
=<идентификатор почтового ящика>)

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

login Строка

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

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

uid Число

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

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

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

POST /api2/registrar/email/del
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]
=<идентификатор почтового ящика>)

Заголовки:

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

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

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

Имя домена.

login Строка

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

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

uid Число

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

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

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

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

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

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

{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

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

Тип значения

Строка

Описание

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

]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-адрес почтового ящика.

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