Метод CreateConfigurationSet
Создает конфигурацию в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Запрос
POST /v2/email/configuration-sets HTTP/2
Заголовки запроса
Используйте в запросе общие заголовки.
Тело запроса
{
"ConfigurationSetName": "<название_конфигурации>",
"SuppressionOptions": {
"SuppressedReasons": ["BOUNCE", "COMPLAINT"]
},
"DeliveryOptions": {
"TlsPolicy": "REQUIRE|OPTIONAL",
"SendingPoolName": "<имя_пула>"
},
"Tags": [
{
"Key": "<ключ_метки>",
"Value": "<значение_метки>"
}
]
}
|
Параметр |
Описание |
|
|
Тип: string. Название конфигурации. |
|
|
Тип: object. Настройки стоп-листа для конфигурации. Содержит массив |
|
|
Тип: array. Причины, по которым адрес из стоп-листа блокирует отправку письма. Возможные значения элементов массива: Если массив содержит значение |
|
|
Тип: object. Настройки доставки писем, отправленных с конфигурацией. Необязательный параметр. Изменить настройки доставки у существующей конфигурации можно с помощью метода PutConfigurationSetDeliveryOptions. |
|
|
Тип: string. Политика безопасности исходящего соединения. Указывает, требуется ли использовать протокол TLS для писем, к которым применена конфигурация. Если значение — |
|
|
Тип: string. Имя пула, с IP-адресов которого будут отправляться письма с конфигурацией. Необязательный параметр. |
|
|
Тип: array. Массив меток для конфигурации. Максимальное количество — 50 меток. |
|
|
Тип: string. Ключ метки. Минимальная длина ключевого слова — 1 символ, максимальная — 63 символа. |
|
|
Тип: string. Значение метки. Минимальная длина значения метки — 0 символов (значение отсутствует), максимальная — 256 символов. |
Ответы
200 OK
Ответ 200 OK возвращается в случае успешного выполнения запроса.
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе переданы неправильные заголовки или параметры. |
|
|
Не найден запрашиваемый ресурс. |
|
|
Конфигурация с таким названием уже существует, выберите другое имя. |
|
|
Конфликт операций. Дождитесь завершения предыдущей операции и повторите запрос. |
|
|
При вызове запроса превышена квота. |
|
|
При вызове запроса превышен лимит. |