Создание и обновление правил маршрутизации

Создает новые или обновляет существующие правила маршрутизации для организации.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение:

ya360_admin:mail_write_domain_routes — управление правилами маршрутизации организации.

Запрос

POST https://cloud-api.yandex.net/v1/mail/organizations/{org_id}/routes/set

Path-параметры

Имя параметра	Тип	Описание
org_id *	integer	Идентификатор организации отправителя письма.

Заголовки

Authorization: OAuth <токен>
Content-Type: application/json

Тело запроса

Имя параметра

Тип

Описание

items *

SchemaRoutingRuleAdminSet[]

Список правил маршрутизации.

Возможное количество правил в запросе: от 1 до 1000.

SchemaRoutingRuleAdminSet

Имя параметра	Тип	Описание
recipient_domain *	string	Домен получателя письма. Среди доменов в теле запроса не должно быть некорректных и одинаковых.
relay *	string	Адрес почтового сервера.
recipient_category *	string	Категория получателей, для которых необходимо выполнять отправку на заданный адрес почтового сервера. Возможные значения: `ALL_RECIPIENTS` — все получатели. `EXTERNAL_RECIPIENTS` — внешние получатели: Для правил с указанным доменом категория `EXTERNAL_RECIPIENTS` означает получателей, которые не являются Яндекс-получателями и у которых нет UID в blackbox. Для правил с пустым доменом (`""`) категория `EXTERNAL_RECIPIENTS` означает внешних по отношению к организации получателей.
description	string	Описание правила маршрутизации. Возможная длина: от 1 до 200 символов.

Пример

Пример запроса

curl -X POST -H "Authorization: OAuth <токен>" -H "Content-Type: application/json" -d '{
  "items": [
    {
      "recipient_domain": "example.com",
      "relay": "mx.example.com",
      "recipient_category": "EXTERNAL_RECIPIENTS",
      "description": "Маршрутизация для внешних получателей"
    },
    {
      "recipient_domain": "test.org",
      "relay": "mx.test.org",
      "recipient_category": "ALL_RECIPIENTS",
      "description": "Маршрутизация для всех получателей"
    }
  ]
}' https://cloud-api.yandex.net/v1/mail/organizations/1234567/routes/set

Ответ

Успешный ответ

Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится сообщение об успешном выполнении операции.

200 OK — запрос выполнен успешно.

Имя параметра	Тип	Описание
message *	string	Подробное описание статуса выполнения операции.

Пример

Пример ответа

{
  "message": "set operation has succeeded"
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

400 Bad Request — параметры запроса не заданы или заданы неверно;
401 Unauthorized — пользователь не авторизован;
403 Forbidden — у пользователя или приложения нет прав на доступ к правилам маршрутизации;
405 Method Not Allowed — неподдерживаемый HTTP-метод;
422 Unprocessable Entity — ошибки в спецификации запроса;
500 Internal Server Error — ошибка произошла на стороне сервера.

Если доступна подробная информацию об ошибке, вы можете посмотреть ее в поле details в теле ответа.

Была ли статья полезна?

Поиск правил маршрутизации

Удаление правил маршрутизации