Перейти к основному содержимому

Обновить шаблон сообщения

Описание

Добавить новый шаблон сообщения.

URL-адрес

Метод: POST

https://example.com/api/v1.1/templates/update

Параметры запроса

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных
(по умолчанию – "json")
idint1ДаИдентификатор шаблона сообщения
namestring"Шаблон для подтверждения подписки"ДаНазвание шаблона
descrstring"Шаблон используется в сценарии Double Opt-In"НетОписание шаблона
channels[]channels
"channels": [
   {
      "sid": "email",
      "fields": {
         "text": "Текстовая версия письма",
         "html": "Hello, world!",
         "subject": "Тема письма",
         "from_email": "",
         "from_name": "",
         "replyto_email": "",
         "replyto_name": ""
      }
   }
]
ДаНастройки шаблона для конкретного канала

Подробнее

json_urlstring"https://altcraft.com/public/assets/example/test.json"НетСсылка на динамический JSON контент
ui_tags[]string["tag_1","tag_2"]НетСписок тегов
groups[]int[1,2]НетСписок идентификаторов групп доступа
is_draftboolfalseНетЕсли это черновик, то шаблон нельзя отправить
is_confirmbooltrueНетИмеется ли ссылка подтверждения в теле письма
suppress_idint2НетИдентификатор стоп-списка

Пример запроса

{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 10,
"name": "Название шаблона",
"descr": "Описание шаблона",
"channels": [
{
"sid": "email",
"fields": {
"text": "Текстовая версия письма",
"html": "<html>Hello, world!</html>",
"subject": "Шаблон сообщения",
"from_email": "",
"from_name": "",
"replyto_email": "",
"replyto_name": "",
"is_not_inline": true
}
}
],
"json_url": "https://altcraft.com/public/assets/example/test.json",
"ui_tags": ["tag_1", "tag_2"],
"groups": [],
"is_draft": false,
"is_confirm": false,
"suppress_id": 4
}

Пример ответа

{
"data": {
"saved_id": 10
},
"error": 0,
"error_text": "Successful operation"
}

Возвращаемые параметры

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
saved_idstringИдентификатор обновленного шаблона