Изменить правила

  1. HTTP-запрос
  2. Path-параметры
  3. Тело запроса
    1. Представление
    2. Поля
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

HTTP-запрос

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

Path-параметры

orgId *

integer

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

orgId *

integer

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

Тело запроса

{
  "rules": [
    {
      "actions": [
        {
          "action": string,
          "data": {
            "email": string
          }
        }
      ],
      "terminal": boolean
    }
  ]
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

rules[]

array

Список правил.

rules[].actions[]

array

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

rules[].actions[].action

string

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

Значение по умолчанию: drop.

Возможные значения
  1. drop
  2. forward

rules[].actions[].data

object

rules[].actions[].data.email

string

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

rules[].condition

object

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

rules[].terminal

boolean

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

rules[]

array

Список правил.

rules[].actions[]

array

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

rules[].actions[].action

string

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

Значение по умолчанию: drop.

Возможные значения
  1. drop
  2. forward

rules[].actions[].data

object

rules[].actions[].data.email

string

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

rules[].condition

object

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

rules[].terminal

boolean

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

Ответы

Код 200

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

{}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

Код 401

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 403

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 404

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 500

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string