Добавить шаблон сообщения
Описание
Добавить новый шаблон сообщения.
URL-адрес
Метод: POST
https://example.com/api/v1.1/templates/add
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
| name | string | "Шаблон для подтверждения подписки" | Да | Название шаблона |
| descr | string | "Шаблон используется в сценарии Double Opt-In" | Нет | Описание шаблона |
| channels | объект | "channels": [ | Да | Настройки шаблона для конкретного канала Подробнее |
| 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",
"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/example/message.json",
"ui_tags": ["tag_1", "tag_2"],
"groups": [1, 2],
"is_draft": false,
"is_confirm": false,
"suppress_id": 2
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<name>Template</name>
<descr>Template description</descr>
<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>
<is_confirm>false</is_confirm>
<is_draft>false</is_draft>
<json_url>https://altcraft.com/example/message.json</json_url>
<suppress_id>2</suppress_id>
<groups>1</groups>
<groups>2</groups>
<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 | Идентификатор созданного шаблона |