Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод createEmailTemplate

Метод для создания шаблона email письма для массовой рассылки. Для редактирования существующего шаблона можно использовать метод updateEmailTemplate

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

Синтаксис и URL для вызова метода
createEmailTemplate (string title, string sender_name, string sender_email,
string subject, string body [, int list_id, string tag, int segment_id, string lang,
string message_format, string text_body, string raw_body, string description])
https://api.unisender.com/ru/api/createEmailTemplate?format=json&api_key=KEY&title=TITLE&sender_name=
FROMNAME&sender_email=FROMMAIL&subject=SUBJECT&body=
HTMLBODY&list_id=X&tag=TAG&segment_id=X&lang=
LANG&message_format=FORMAT&text_body=TEXTBODY&raw_body=
RAW&description=DESCRIPTION
Аргументы
api_key * Ключ доступа к API
title * Название шаблона
sender_name * Имя отправителя. Произвольная строка, не совпадающая с email адресом (аргумент sender_email).
sender_email * Email адрес отправителя. Этот email должен быть проверен (для этого надо создать вручную хотя бы одно письмо с этим обратным адресом через веб-интерфейс, затем нажать на ссылку «отправьте запрос подтверждения» и перейти по ссылке из письма).
subject * Строка с темой письма. Может включать поля подстановки.
body * Текст шаблона письма в формате HTML с возможностью добавлять поля подстановки.

Если вы передаёте текст HTML целиком, то тестируйте такие письма дополнительно – заголовки вне body могут быть подвергнуты модификациям. Кроме того, чтобы уменьшить расхождение в отображении в различных почтовых программах, мы автоматически добавляем дополнительную разметку в каждое письмо (таблица с невидимыми границами, которая также задаёт шрифт по умолчанию и выравнивание текста по левой границе). Вы можете попросить отключить это для ваших писем, обратившись в техподдержку.

description Текстовое описание шаблона, которое в дальнейшем можно будет получить при вызове этого шаблона.
list_id Код списка, для которого по умолчанию создается шаблон. Коды всех списков можно получить с помощью вызова getLists.
text_body Текстовый вариант шаблона письма.
segment_id Код сегмента, для которого создается шаблон.
tag Метка. Если задана, то отправка рассылки письма из шаблона будет производиться не по всему списку, а только по тем адресатам, которым присвоена заданная метка.
lang Двухбуквенный код языка для автоматически добавляемой в каждое письмо строки со ссылкой отписки.

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

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

message_format Определяет способ создания шаблона: «block» — блочный редактор, «raw_html» — html редактор, text — текст.

  • Если передать в этом параметре значение «text», то в случае, если оба параметра body и text_body будут заполнены, параметр body будет проигнорирован, а шаблон будет создан из данных, переданных в параметре text_body.
  • Если передать в этом параметре значение «block», но не задать raw_body, тогда шаблон будет сохранен как raw_html.
  • Если передать в этом параметре значение «block», для того, чтобы сообщение было сохранено в формате блочного редактора, обязательно должны быть переданы параметры body и raw_body.
raw_body Предназначен для сохранения json структуры структуры данных блочного редактора (при значении message_format=block). Параметр принимает только JSON-структуру, в противном случае не будет передан.
Возвращаемое значение
JSON-объект с полями:

template_id — идентификатор созданного шаблона;

warnings — массив, содержащий поля warning — предупреждения (если они были).

Пример возвращаемого значения при успешном создании шаблона:

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

При ошибке:

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