Удаление правил маршрутизации
Удаляет правила маршрутизации для указанных доменов организации.
Примечание
Чтобы выполнить запрос, приложению требуется разрешение:
ya360_admin:mail_write_domain_routes— управление правилами маршрутизации организации.
Запрос
POST https://cloud-api.yandex.net/v1/mail/organizations/{org_id}/routes/remove
Path-параметры
|
Имя параметра |
Тип |
Описание |
|
org_id * |
integer |
Идентификатор организации отправителя письма. |
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса
|
Имя параметра |
Тип |
Описание |
|
items * |
Список доменов для удаления. Среди доменов в теле запроса не должно быть некорректных и одинаковых. Возможное количество доменов в запросе: от 1 до 1000. |
SchemaRoutingRecipientDomain
|
Имя параметра |
Тип |
Описание |
|
recipient_domain * |
string |
Домен получателя письма. |
Пример
Пример запроса
curl -X POST -H "Authorization: OAuth <токен>" -H "Content-Type: application/json" -d '{
"items": [
{
"recipient_domain": "example.com"
},
{
"recipient_domain": "test.org"
}
]
}' https://cloud-api.yandex.net/v1/mail/organizations/1234567/routes/remove
Ответ
Успешный ответ
Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится сообщение об успешном выполнении операции.
200 OK — запрос выполнен успешно.
|
Имя параметра |
Тип |
Описание |
|
message * |
string |
Подробное описание статуса выполнения операции. |
Пример
Пример ответа
{
"message": "remove operation has succeeded"
}
Неуспешный ответ
Ошибки могут быть со следующими HTTP-статусами:
400 Bad Request— параметры запроса не заданы или заданы неверно;401 Unauthorized— пользователь не авторизован;403 Forbidden— у пользователя или приложения нет прав на доступ к правилам маршрутизации;405 Method Not Allowed— неподдерживаемый HTTP-метод;422 Unprocessable Entity— ошибки в спецификации запроса;500 Internal Server Error— ошибка произошла на стороне сервера.
Если доступна подробная информацию об ошибке, вы можете посмотреть ее в поле details в теле ответа.