Установить страну для домена

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

По умолчанию страна домена соответствует той, которая указана в учетной записи администратора домена в Яндекс.Паспорте.

Данная настройка не связана со страной, для которой выделена DNS-зона домена.

  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

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

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

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

domain=<имя домена>
&country=<код страны домена>

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

country Строка

Код страны домена согласно ISO 3166-1 (например, «ru» — код России, «ua» — код Украины).

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

POST /api2/admin/domain/settings/set_country HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&country=ru
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&country=ru' 'https://pddimp.yandex.ru/api2/admin/domain/settings/set_country'

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

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

Имя домена.

country Строка

Установленный код страны домена (согласно ISO 3166-1).

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