Задать список правил

Создает или обновляет список правил обработки писем.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение на управление правилами обработки почты для домена. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.

Request

PUT

https://api360.yandex.net/admin/v1/org/{orgId}/mail/routing/rules

Path parameters

Name

Description

orgId*

Type: integer<int64>

Идентификатор организации.

Body

application/json
{
    "orgId": 1234,
    "rules": [
        {
            "foo": {
                "bar": "baz"
            }
        }
    ]
}

Name

Description

rules

Type: v1RuleParams[]

Список правил обработки писем.

v1RuleParams

Name

Description

actions

Type: v1RuleActionParams[]

JSON-описание (массив) действий, которые необходимо выполнить при срабатывании правила.

condition

Type: any

JSON-описание условия (составного условия), задающее критерий соответствия письма текущему правилу. Подробное описание парамета.

terminal

Type: boolean

Признак необходимости прекратить применение последующих правил при срабатывании данного.

v1RuleActionParams

Name

Description

action

Type: RuleActionParamsRuleAction

Действие.

Default: drop

Enum: drop, forward

data

Type: v1RuleActionData

Допоплнительные данные для действия.

RuleActionParamsRuleAction

  • drop: Действие «Удаление».
  • forward: Действие «Пересылка».

Type

Description

RuleActionParamsRuleAction

Default: drop

Enum: drop, forward

v1RuleActionData

Name

Description

email

Type: string

Адрес пересылки.

Responses

200 OK

Запрос успешно выполнен.

Body

application/json
{}

401 Unauthorized

Пользователь не авторизован.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.
Предыдущая
Просмотреть список правил
Следующая
Обзор