Yandex Cloud
Документация
ПрезентацияСвязаться с намиНачать бесплатно
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»
Yandex Cloud Postbox
RU
  • Начало работы
  • Управление доступом
  • Правила тарификации
    • Аутентификация в API
    • Как пользоваться API
    • Подписывание запросов
      • Все методы
      • Отправка писем
      • Массовая отправка писем
        • Метод ListConfigurationSets
        • Метод GetConfigurationSet
        • Метод CreateConfigurationSet
        • Метод PutDomainIdentityConfigurationSetAttributes
        • Метод DeleteConfigurationSet
        • Метод PutConfigurationSetDeliveryOptions
        • Метод PutConfigurationSetSuppressionOptions
        • Метод PutConfigurationSetVdmOptions
      • Заголовки запросов
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Вопросы и ответы

В этой статье:

  • Запрос
  • Path-параметры
  • Заголовки запроса
  • Тело запроса
  • Ответы
  • 200 OK
  • Ошибки
  1. Справочник API
  2. REST
  3. Конфигурации
  4. Метод PutConfigurationSetVdmOptions

Метод PutConfigurationSetVdmOptions

Статья создана
Yandex Cloud
Обновлена 16 ноября 2026 г.
Открыть в Markdown
  • Запрос
    • Path-параметры
    • Заголовки запроса
    • Тело запроса
  • Ответы
    • 200 OK
    • Ошибки

Обновляет настройки сбора статистики для конфигурации в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.

Из настроек VDM (Virtual Deliverability Manager) Amazon SES Yandex Cloud Postbox поддерживает только параметр DashboardOptions.EngagementMetrics.

ЗапросЗапрос

PUT /v2/email/configuration-sets/{ConfigurationSetName}/vdm-options HTTP/2

Path-параметрыPath-параметры

Параметр

Описание

ConfigurationSetName

Тип: string.

Название конфигурации, которая будет изменена.

Заголовки запросаЗаголовки запроса

Используйте в запросе общие заголовки.

Тело запросаТело запроса

{
  "VdmOptions": {
    "DashboardOptions": {
      "EngagementMetrics": "ENABLED|DISABLED"
    }
  }
}

Параметр

Описание

VdmOptions

Тип: object.

Настройки сбора статистики. Содержит объект DashboardOptions.

Если объект VdmOptions или вложенный объект DashboardOptions не передан, метод возвращает 200 OK и не изменяет настройки конфигурации.

DashboardOptions

Тип: object.

Объект, который содержит параметр EngagementMetrics.

EngagementMetrics

Тип: string.

Отслеживание открытия писем и переходов по ссылкам для сбора метрик Открытия и Переходы. Возможные значения: ENABLED — отслеживание включено, DISABLED — выключено.

Параметр соответствует опции Статистика вовлечённости в консоли управления. Уведомления в поток данных Data Streams при этом не отправляются. Чтобы получать уведомления об открытиях и переходах, создайте подписку с типами событий OPEN и CLICK.

ОтветыОтветы

200 OK200 OK

Ответ 200 OK возвращается в случае успешного выполнения запроса.

ОшибкиОшибки

Для всех ошибок тело ответа представлено в одинаковом формате:

{
   "Code": "<название_ошибки>",
   "message": "<пояснение_к_ошибке>"
}

Название ошибки заимствуется из ее кода, например BadRequestException.

Возможные ошибки:

Код ошибки

Описание

400 BadRequestException

В запросе неправильно указаны заголовки или параметры.

404 NotFoundException

Конфигурация не найдена.

429 TooManyRequestsException

При вызове запроса превышена квота.

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

Предыдущая
Метод PutConfigurationSetSuppressionOptions
Следующая
Метод ListSuppressedDestinations
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»