меню
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод updateEmailMessage

Метод для редактирования существующего email сообщения (без отправки). Создать новое email сообщение можно с помощью метода createEmailMessage.

Принцип использования

Синтаксис и URL для вызова метода
updateEmailMessage (int id [,string sender_name, string sender_email,
string subject, string body, int list_id, string message_format, string lang,
string text_body, string raw_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&messsage_format=FORMAT&raw_body=RAW&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 Текстовый вариант письма.
message_format Определяет способ создания письма: «block» — блочный редактор, «raw_html» — html редактор, «text» — текст.

  • Если передать в этом параметре значение «text», то в случае, если оба параметра body и text_body будут заполнены, параметр body будет проигнорирован, а шаблон будет создан из данных, переданных в параметре text_body.
  • Если передать в этом параметре значение «block», но не задать raw_body, тогда шаблон будет сохранен как raw_html.
  • Если передать в этом параметре значение «block», для того, чтобы сообщение было сохранено в формате блочного редактора, обязательно должны быть переданы параметры body и raw_body.
lang Двухбуквенный код языка для автоматически добавляемой в каждое письмо строки со ссылкой отписки.

Если не указан, то используется код языка из URL-обращения к API.

Кроме собственно строки со ссылкой отписки, этот язык также влияет на интрефейс страницы отписки. Полностью поддерживаются языки ruit, ua и en, для нескольких других языков (da, de, es, fr, nl, pl, pt, tr) будет переведена строка со ссылкой, а интерфейс управления будет на английском.

raw_body Предназначен для сохранения json структуры структуры данных блочного редактора (при значении message_format=block). Параметр принимает только JSON-структуру, в противном случае не будет передан.
categories Категории письма, перечисленные в текстовом виде через запятую
Возвращаемое значение
JSON-объект с одним полем message_id, в котором содержится уникальный код сообщения – целое положительное 31-битное число. Используется для отправки сообщения методом createCampaign.
Значение message_id может отличаться от id в связи с созданием новой версии письма.Пример возвращаемого значения при удачном выполнении запроса:

{
    "result":{},
    "warnings":[{"warning":"some warning text, if applicable"}]
}

Пример возвращаемого значения при ошибке:

{"error":"error message", "code":"error code"}