Создать правило автоответа или пересылки
Метод позволяет создать правило автоответа или пересылки писем для сотрудника. Возможность пересылки есть только на домены, которые принадлежат выбранной организации. Подтверждение получения пересылки при создании такого правила не требуется.
Примечание
Чтобы выполнить запрос, приложению требуется разрешение на управление настройками почты пользователя. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.
Request
POST
https://api360.yandex.net/admin/v1/org/{orgId}/mail/users/{userId}/settings/user_rules
Path parameters
|
Name |
Description |
|
orgId |
Type: integer Идентификатор организации. |
|
userId |
Type: string<uint64> Идентификатор пользователя. Example: `` |
Body
application/json
{
"autoreply": {
"ruleName": "example",
"text": "example"
},
"forward": {
"ruleName": "example",
"address": "example",
"withStore": true
}
}
|
Name |
Description |
|
autoreply |
Type: v1CreateUserAutoreplyRule Example |
|
forward |
Type: v1CreateUserForwardRule Example |
v1CreateUserAutoreplyRule
|
Name |
Description |
|
ruleName |
Type: string Название правила. Example: |
|
text |
Type: string Текст автоответа. Example: |
Example
{
"ruleName": "example",
"text": "example"
}
v1CreateUserForwardRule
|
Name |
Description |
|
address |
Type: string Email получателя пересылаемого письма. Example: |
|
ruleName |
Type: string Название правила. Example: |
|
withStore |
Type: boolean Признак того, нужно ли сохранять копию письма в ящике исходного получателя. |
Example
{
"ruleName": "example",
"address": "example",
"withStore": true
}
Responses
200 OK
Запрос успешно выполнен.
Body
application/json
{
"ruleId": 0
}
|
Name |
Description |
|
ruleId |
Type: integer Идентификатор правила. |
400 Bad Request
Некорректный запрос.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
protobufAny
|
Name |
Description |
|
@type |
Type: string Example: |
|
[additional] |
Type: unknown Example: |
Example
{
"@type": "example"
}
401 Unauthorized
Пользователь не авторизован.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
403 Forbidden
У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
500 Internal Server Error
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
No longer supported, please use an alternative and newer version.