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

Шаблоны email

Все шаблоны

GET api/email-templates

Response:

{
"status": "ok",
"timestamp": 1684402652000,
"data": [
{
"id": 34,
"title": "Подтверждения email",
"channel": null,
"template": {
"ru": [
{
"type": "heading",
"data": "Подтверждения эл. почты"
},
{
"type": "paragraph",
"data": [
{
"type": "text",
"data": "Нажмите на ссылку, для подтверждения электронной почты"
}
]
},
{
"type": "button",
"data": {
"title": "Оформить заявку",
"link": "${verifyLink}"
}
}
]
},
"plain_text": null,
"subject": {
"ru": "Перейдите по ссылке для подтверждения эл. почты."
},
"email_from": null,
"email_from_name": null,
"deleted_at": null,
"created_at": null,
"updated_at": null
}
]
}

Шаблон по ID

GET api/email-templates/{id}

Добавление шаблона

POST api/email-templates

Request body: шаблон email

Изменение шаблона

PUT api/email-templates/{id}

Request body: шаблон email

Удаление шаблона

DELETE api/email-templates/{id}

Объект шаблона Email

FieldRequiredTypeDescription
titlestringНазвание шаблона
templateobject[]Щабллон email сообщения для конструктора.
plain_textstring[]Шаблон email для текстового сообщения
subjectstring[]Заголовок письма
email_fromemailЭл. почта отправителя. Если не указан, используется глобальная настройка
email_from_namestringИмя отправителя. Если не указан, используется глобальная настройка
подсказка

Шаблоны письма и заголовок нужно прописывать с указанием языка.

{
"template": {
"ru": "Шаблон сообщения на русском",
"en": "Message in english"
}
}

Для прописывания переменных нужно использовать сигнатуру ${variableName}