Документация для версии v74

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

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
id	int	1	Да	Идентификатор шаблона сообщения
name	string	"Шаблон для подтверждения подписки"	Да	Название шаблона
descr	string	"Шаблон используется в сценарии Double Opt-In"	Нет	Описание шаблона
channels	[]channels	"channels": [ { "sid": "email", "fields": { "text": "Текстовая версия письма", "html": "Hello, world!", "subject": "Тема письма", "from_email": "", "from_name": "", "replyto_email": "", "replyto_name": "" } } ]	Да	Настройки шаблона для конкретного канала Подробнее
json_url	string	`"https://altcraft.com/public/assets/example/test.json"`	Нет	Ссылка на динамический JSON-контент
ui_tags	[]string	`["tag_1","tag_2"]`	Нет	Список тегов
groups	[]int	`[1,2]`	Нет	Список идентификаторов групп доступа
is_draft	bool	false	Нет	Если это черновик, то шаблон нельзя отправить
is_confirm	bool	true	Нет	Имеется ли ссылка подтверждения в теле письма
suppress_id	int	2	Нет	Идентификатор стоп-списка

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

JSON
XML

{
  "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
}

<xml>
  <channels array = 'true'>
    <fields>
      <body>Hello, world!</body>
      <click_url>https://example.com</click_url>
      <icon>https://example.com/images/picture.jpg</icon>
      <title>Welcome</title>
    </fields>
    <sid>push</sid>
  </channels>
  <descr>Template description</descr>
  <groups>1</groups>
  <groups>2</groups>
  <is_confirm>false</is_confirm>
  <is_draft>false</is_draft>
  <json_url>https://altcraft.com/example/message.json</json_url>
  <id>10</id>
  <name>Template</name>
  <suppress_id>2</suppress_id>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <ui_tags>tag_1</ui_tags>
  <ui_tags>tag_2</ui_tags>
</xml>

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

JSON
XML

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

<xml>
  <data>
    <saved_id>10</saved_id>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
saved_id	string	Идентификатор обновленного шаблона

Описание​

URL-адрес​

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

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

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

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

Описание

URL-адрес

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

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

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

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