Set the interface language

This request is used for setting the language of the email interface for the domain.

  1. Request syntax
  2. Request example
  3. Response structure

Request syntax

The request should be sent over the HTTPS protocol using the POST method.

POST /api2/admin/domain/settings/set_country
Host: pddimp.yandex.ru
PddToken: <PDD token>
...

domain=<domain name>
&country=<interface language>

Headers:

NameDescription
PddToken

PDD token.

Parameters:

ParameterTypeValue
Mandatory
domainString

Name of the domain.

countryString

The default language of the mailbox interface for the domain.

Included in the response if the domain has been verified (the status value is set to mx-activate or added).

Possible values:
  • ru — Russian.
  • en — English.
  • ua — Ukrainian.
  • tr — Turkish.
  • by — Belarusian.
  • az — Azerbaijani.
  • ro — Romanian.
  • ge — Georgian.
  • kz — Kazakh.

Request example

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'

Response structure

{
  "domain": "{domain name}", 
  "success": "{status of request execution}", 
  "error": "{error code}"
}
NameType of valueDescription
domainString

Name of the domain.

successString

Status of request execution.

Possible values:
  • ok — Request executed successfully.
  • error — Request executed with error.
errorString

Error code.

Included in the response if the request resulted in an error.

Possible values:
  • unknown — A temporary failure or API error occurred (repeat the request again later).
  • no_token (no_domain, no_ip ) — A mandatory parameter was omitted.
  • bad_domain — The domain name was not specified or does not conform to the RFC.
  • prohibited — A forbidden domain name.
  • bad_token (bad_login, bad_passwd) — An invalid PDD token (or username/password) was passed.
  • no_auth — The PddToken header was omitted.
  • not_allowed — This operation is not allowed for this user (the user is not the domain administrator).
  • blocked — Blocked domain (for example, due to spam and so on).
  • occupied — The domain name is in use by another user.
  • domain_limit_reached — Exceeded the acceptable number of connected domains (50).
  • no_reply — Yandex.Mail for Domain cannot connect to the server source for the import.