Метод PutConfigurationSetVdmOptions
Обновляет настройки сбора статистики для конфигурации в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Из настроек VDM (Virtual Deliverability Manager) Amazon SES Yandex Cloud Postbox поддерживает только параметр DashboardOptions.EngagementMetrics.
Запрос
PUT /v2/email/configuration-sets/{ConfigurationSetName}/vdm-options HTTP/2
Path-параметры
|
Параметр |
Описание |
|
|
Тип: string. Название конфигурации, которая будет изменена. |
Заголовки запроса
Используйте в запросе общие заголовки.
Тело запроса
{
"VdmOptions": {
"DashboardOptions": {
"EngagementMetrics": "ENABLED|DISABLED"
}
}
}
|
Параметр |
Описание |
|
|
Тип: object. Настройки сбора статистики. Содержит объект Если объект |
|
|
Тип: object. Объект, который содержит параметр |
|
|
Тип: string. Отслеживание открытия писем и переходов по ссылкам для сбора метрик Параметр соответствует опции Статистика вовлечённости в консоли управления. Уведомления в поток данных Data Streams при этом не отправляются. Чтобы получать уведомления об открытиях и переходах, создайте подписку с типами событий |
Ответы
200 OK
Ответ 200 OK возвращается в случае успешного выполнения запроса.
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе неправильно указаны заголовки или параметры. |
|
|
Конфигурация не найдена. |
|
|
При вызове запроса превышена квота. |