Add a mailbox

This request is used for adding a mailbox for the domain.

Request syntax

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

POST /api2/admin/email/add
Host: pddimp.yandex.ru
PddToken: <PDD token>
...

domain=<domain name>
&login=<mailbox username>
&password=<password>

Headers:


Name	Description
PddToken	PDD token.

Parameters:


Parameter	Type	Value
Mandatory
domain	String	Name of the domain.
login	String	The email address of the mailbox, in the format “username@domain.ru” or “username”.
password	String	User's password. The password must: contain from 6 to 20 characters — Latin letters, numbers, and the symbols “!”, “@”, “#”, “$”, “%”, “^”, “&”, “*”, “(”, “)”, “_”, “-”, “+”, “:”, “;”, “,”, “.” be different from the username.


Parameter	Type	Value
Mandatory
domain	String	Name of the domain.
login	String	The email address of the mailbox, in the format “username@domain.ru” or “username”.
password	String	User's password. The password must: contain from 6 to 20 characters — Latin letters, numbers, and the symbols “!”, “@”, “#”, “$”, “%”, “^”, “&”, “*”, “(”, “)”, “_”, “-”, “+”, “:”, “;”, “,”, “.” be different from the username.

POST /api2/registrar/email/add
Host: pddimp.yandex.ru
PddToken: <PDD token>
Authorization: OAuth <OAuth token>
...

domain=<domain name>
&login=<mailbox username>
&password=<password>

Headers:


Name	Description
PddToken	PDD token.
Authorization	OAuth access token.

Parameters:


Parameter	Type	Value
Mandatory
domain	String	Name of the domain.
login	String	The email address of the mailbox, in the format “username@domain.ru” or “username”.
password	String	User's password. The password must: contain from 6 to 20 characters — Latin letters, numbers, and the symbols “!”, “@”, “#”, “$”, “%”, “^”, “&”, “*”, “(”, “)”, “_”, “-”, “+”, “:”, “;”, “,”, “.” be different from the username.


Parameter	Type	Value
Mandatory
domain	String	Name of the domain.
login	String	The email address of the mailbox, in the format “username@domain.ru” or “username”.
password	String	User's password. The password must: contain from 6 to 20 characters — Latin letters, numbers, and the symbols “!”, “@”, “#”, “$”, “%”, “^”, “&”, “*”, “(”, “)”, “_”, “-”, “+”, “:”, “;”, “,”, “.” be different from the username.

Request example

POST /api2/admin/email/add HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&login=newlogin&password=1234567890

cURL

curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&login=newlogin&password=1234567890' 'https://pddimp.yandex.ru/api2/admin/email/add'

POST /api2/admin/email/add HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com&login=newlogin&password=1234567890

cURL

curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'domain=domain.com&login=newlogin&password=1234567890' 'https://pddimp.yandex.ru/api2/admin/email/add'

Response structure

{
  "domain": "{domain name}",
  "login":"{email address of the mailbox}",
  "uid": "{mailbox ID}",
  "success": "{status of request execution}"
}

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


Name	Type of value	Description
`domain`	String	Name of the domain.
`login`	String	Email address of the mailbox.
`uid`	Integer	Mailbox ID.
`success`	String	Status of request execution. Possible values: `ok` — Request executed successfully. `error` — Request executed with error.
`error`	String	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.


Name	Type of value	Description
`domain`	String	Name of the domain.
`login`	String	Email address of the mailbox.
`uid`	Integer	Mailbox ID.
`success`	String	Status of request execution. Possible values: `ok` — Request executed successfully. `error` — Request executed with error.
`error`	String	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.