Позволяет редактировать любые активные или приостановленные сообщения. Данные, которые не будут переданы в этом запросе, не изменятся.
Формат запроса
Параметры ссылки запроса:
Параметр
Тип
Описание
ID
integer
ID транзакционного письма. Обязательно указывается в адресе
(не внутри запроса).
Элементы тега Data:
Элемент/атрибут
Тип
Описание
Content
complex
Содержание письма. Обязательный.
SuppressionLists
array[integer]
Содержит ID стоп-листов, которые будут проверены перед отправкой. Необязательный.
Channels
array[complex]
Содержит каналы для отправки. Необязательный. Если не указан, то используются стандартные каналы.
Status
string
Статус транзакционного письма. Может принимать значения: Active, Inactive. Необязательный. По умолчанию, для новых сообщений используются значение Active.
*Добавление любых стоп-листов в этот элемент заменит предыдущие стоп-листы для этого сообщения. Если элемент оставить пустым, то все стоп-листы для этого сообщения будут удалены.
**Добавление любых каналов в этот элемент заменит предыдущие каналы для отправки этого сообщения. Если элемент оставить пустым, то все каналы отправки для этого сообщения будут удалены.
Элементы тега Content:
Элемент/атрибут
Тип
Описание
FromName
string
Имя отправителя. Отображается в поле From. Обязательный.
FromEmail
string
Емейл отправителя. Отображается в поле From. Обязательный.
ReplyToName
string
Имя, которое отображается в поле Reply-To. Необязательный.
ReplyToEmail
string
Емейл, который отображается в поле Reply-To. Необязательный.
Subject
string
Тема письма. Обязательный.
Html
string
Html-контент. Должен быть заключен в секцию CDATA для передачи в XML. Смотрите примеры. Необязательный.*
Plain
string
Текстовое содержание сообщения. Необязательный.*
AmpHtml
string
AMP HTML-контент транзакционного письма. Данные должны быть помещены в раздел CDATA для транспорта XML. Необязательный. Подробнее в Примерах.
Preheader
string
Прехедер транзакционного письма. Необязательный.
Header
integer
ID шаблона заголовка. Необязательный.
Footer
integer
ID шаблона футера. Необязательный.
ContentFromUrl
complex
Используется, если содержание сообщения не передается в XML, а находится на внешнем источнике. Необязательный.*
GoogleAnalyticsTags
complex
Теги Google Analytics. Используются для вставки в ссылки в сообщении. Необязательный. Если не указан, то не используются в ссылках.
Tags
array[string]
Список тегов для сообщения. Необязательный.
Attachments
complex
Набор элементов Attachments, содержащие, например, кодированные PDF файлы и др. Необязательный.**
UrlIntegrations
complex
Список ID URL-параметров, которые были созданы в настройках субаккаунта. Необязательный.
EnableClickTrack
boolean
При значении false статистика
по кликам собираться не будет. По умолчанию используется значение true. Необязательный.
EnableOpenTrack
boolean
При значении false статистика
по открытиям собираться не будет. По умолчанию используется значение true. Необязательный.
*Вы можете передать содержание сообщения, используя параметры HTML, Plain и / или AmpHtml, или загрузить из внешнего источника (например, веб-страница или ftp-сервер с zip- архивом, который содержит HTML и картинки), используя параметр ContentFromUrl. Если содержание сообщения не найдено ни в одном месте, то вернется ошибка. Если существует более одного файла Html, Plain и / или AmpHtml, только последний файл будет содержимым сообщения. Если вы хотите отправить AMP Html, вы должны предоставить Html и / или Plain в качестве резервной версии email.
**Вы можете использовать либо ContentFromUrl, либо Attachments.
Если вы хотите отправить картинки вместе с сообщением, то использование ContentFromUrl - единственный способ сделать это.
Элементы тега ContentFromUrl:
Элемент/атрибут
Тип
Описание
Url
string
URL-адрес загружаемого файла. Поддерживаются протоколы HTTP, HTTPS, FTP, SFTP и FTPS. Например, ftp://www.domain.com/mycreative.zip.
Username
string
Username, используемый для аутентификации. Необязательный.
Password
string
Password, используемый для аутентификации. Необязательный.
FtpAuth
string
Метод аутентификации для защищенных FTP серверов. Необязательный. Может принимать значения:
None - FTP сервер без аутентификации (по умолчанию)
ExplicitTls - сервер с явной TLS/SSL аутентификацией
ExplicitSsl - сервер с явной SSL аутентификацией
ImplicitSsl - сервер с неявной SSL аутентификацией
FtpUseActiveMode
boolean
При значении true для соединения с FTP будет использован active mode. По умолчанию используется значение false.
Элементы тега GoogleAnalyticsTags:
Элемент/атрибут
Тип
Описание
Campaign
string
Тег Google Analytics "utm_campaign". Необязательный.
Source
string
Тег Google Analytics "utm_source". Необязательный.
Content
string
Тег Google Analytics "utm_content". Необязательный.
Пропущенный тег "utm_medium" по умолчанию передается как "Email".
Элементы тега Attachment:
Элемент/атрибут
Тип
Описание
FileName
string
Имя файла вложения, например "infosheet.pdf". Должно быть уникальным ( 2 файла не должны иметь одинаковые имена). Обязательный.
MimeType
string
Тип файла по стандарту MIME, например "application/pdf". Если не указан, то будет использован тип "application/octet-stream".
Необязательный. Тип MIME влияет на то, как различные почтовые клиенты будут обрабатывать вложения, поэтому лучше всего всегда указывать правильный тип.*
Content
string
Содержимое файла вложения. Должно быть кодировано в Base64.** Смотрите пример запроса. Обязательный.
** Кодирование в Base64 доступно для большинства языков программирования. Для дополнительной информации смотрите http://ru.wikipedia.org/wiki/Base64
Элементы тега UrlIntegrations:
Элемент/атрибут
Тип
Описание
Id
int
ID номер существующего, не удаленного параметра. Обязательный.
Элемент тега Channel:
Элемент/атрибут
Тип
Описание
Ip
string
IP адрес канала доставки.
Percentage
integer
Процент емейл адресов, который будет использован для этого канала.
*Сумма процентов для всех выбранных каналов должна быть 100%, иначе вернется сообщение об ошибке. Например, два канала 30 и 70 или 3 канала 25, 25, 50. Список доступных каналов можно найти в настройках в панели ExpertSender.
Ответ
По умолчанию, возвращается пустой ответ и HTTP код "204 No Content".
