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:
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 | |
Authorization |
Name | Description |
---|---|
PddToken | |
Authorization |
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:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|
Name | Type of value | Description |
---|---|---|
signature | String | Signature for messages. |
success | String | Status of request execution. Possible values:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|