Метод для редактирования существующего email сообщения (без отправки). Создать новое email сообщение можно с помощью метода createEmailMessage.
Принцип использования
| Синтаксис и URL для вызова метода |
| updateEmailMessage (int id [,string sender_name, string sender_email, string subject, string body, int list_id, string lang, string text_body, string categories]) |
| https://api.unisender.com/ru/api/updateEmailMessage?format=json&api_key= KEY&id=ID&sender_name=FROMNAME&sender_email= FROMMAIL&subject=SUBJECT&body=HTMLBODY&list_id=X&lang=LANG&text_ body=TEXTBODY&categories=CATEGO |
| Аргументы | |
| api_key * | Ключ доступа к API. |
| id * | Идентификатор сообщения для редактирования, созданного ранее методом createEmailMessage. |
| sender_name | Имя отправителя. Произвольная строка, не совпадающая с email адресом (аргумент sender_email). |
| sender_email | Email адрес отправителя. Этот email должен быть подтвержден (для отправки письма подтверждения можно воспользоваться методом validateSender, или создать вручную хотя бы одно письмо с этим обратным адресом через веб-интерфейс, затем нажать на ссылку «отправьте запрос подтверждения» и перейти по ссылке из письма). |
| subject | Строка с темой письма. Может включать поля подстановки. |
| body | Текст письма в формате HTML с возможностью добавлять поля подстановки.
Если вы передаёте текст HTML целиком, то тестируйте такие письма дополнительно – заголовки вне body могут быть подвергнуты модификациям. Кроме того, чтобы уменьшить расхождение в отображении в различных почтовых программах, мы автоматически добавляем дополнительную разметку в каждое письмо (таблица с невидимыми границами, которая также задаёт шрифт по умолчанию и выравнивание текста по левой границе). Вы можете попросить отключить это для ваших писем, обратившись в техподдержку. |
| list_id | Код списка, по которому будет произведена отправка e-mail рассылки. Коды всех списков можно получить с помощью вызова getLists. Отправка письма возможна только по одному списку. Для отправки по другому списку надо создавать новое письмо. |
| text_body | Текстовый вариант письма. |
| lang | Двухбуквенный код языка для автоматически добавляемой в каждое письмо строки со ссылкой отписки.
Если не указан, то используется код языка из URL-обращения к API. Кроме собственно строки со ссылкой отписки, этот язык также влияет на интрефейс страницы отписки. Полностью поддерживаются языки ru, it, ua и en, для нескольких других языков (da, de, es, fr, nl, pl, pt, tr) будет переведена строка со ссылкой, а интерфейс управления будет на английском. |
| categories | Категории письма, перечисленные в текстовом виде через запятую. |
| Возвращаемое значение |
| JSON-объект с одним полем message_id, в котором содержится уникальный код сообщения – целое положительное 31-битное число. Используется для отправки сообщения методом createCampaign. Значение message_id может отличаться от id в связи с созданием новой версии письма.Пример возвращаемого значения при удачном выполнении запроса: {
"result":{"message_id": 123456789},
"warnings":[{"warning":"some warning text, if applicable"}]
}
Пример возвращаемого значения при ошибке: {"error":"error message", "code":"error code"}
|
