Creating a signature for messages

This request is used for setting a common signature for all messages that will be sent from the user's domains. This signature will automatically appear at the end of each outgoing message (for example, “Sincerely, Alexey Karpov”).

Request syntax

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

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

signature=<signature>

Headers:


Name	Description
PddToken	PDD token.

Parameters:


Parameter	Type	Value
Mandatory
signature	String	Signature for messages.

Parameter	Type	Value
Mandatory
signature	String	Signature for messages.

POST /api2/registrar/domain/settings/setsign
Host: pddimp.yandex.ru
PddToken: <PDD token>
[Authorization: OAuth <OAuth token>]
...

signature=<signature>

Headers:


Name	Description
PddToken	PDD token.
Authorization	OAuth access token.

Parameters:


Parameter	Type	Value
Mandatory
signature	String	Signature for messages.

Parameter	Type	Value
Mandatory
signature	String	Signature for messages.

Request example

POST /api2/admin/domain/settings/setsign HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
signature=--<br>MyName

cURL

curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'signature=--<br>MyName' 'https://pddimp.yandex.ru/api2/admin/domain/settings/setsign'

POST /api2/admin/domain/settings/setsign HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
signature=--<br>MyName

cURL

curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'signature=--<br>MyName' 'https://pddimp.yandex.ru/api2/admin/domain/settings/setsign'

Response structure

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


Name	Type of value	Description
`signature`	String	Signature for messages.
`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
`signature`	String	Signature for messages.
`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.