Метод PutSuppressedDestination
Добавляет адрес в пользовательский стоп-лист. Нужное облако определяется по сервисному аккаунту, от имени которого выполняется запрос.
Запрос
PUT /v2/email/suppression/addresses HTTP/2
Заголовки запроса
Используйте в запросе общие заголовки.
Тело запроса
{
"EmailAddress": "user@example.com",
"Reason": "BOUNCE|COMPLAINT"
}
|
Параметр |
Описание |
|
|
Тип: string. Адрес получателя, который нужно добавить в стоп-лист. |
|
|
Тип: string. Обязательный параметр. Причина добавления адреса в стоп-лист: |
Если адрес уже есть в стоп-листе, новая запись не создается: у текущей записи обновляются причина и время изменения, а время создания сохраняется.
Ответы
200 OK
Ответ 200 OK возвращается в случае успешного выполнения запроса.
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе указан пустой или некорректный адрес либо причина не указана или не равна |
|
|
Недостаточно прав для выполнения запроса. |
|
|
При вызове запроса превышена квота. |