Хранимые шаблоны

Жизненный цикл

У шаблона есть стабильные ID и ключ, один редактируемый черновик, ноль или больше неизменяемых опубликованных релизов и жизненный цикл: активный или архивный. Архивация запрещает новые отправки по ключу, но не удаляет прошлые релизы и историю использования.

Переменные

Объявляйте переменные с ключами, типами, признаком обязательности и необязательными значениями по умолчанию. Если переданные данные не соответствуют опубликованному контракту, рендеринг завершается ошибкой 422. Подставляемые значения экранируются с учётом контекста.

Оптимистичное автосохранение

У каждого черновика есть ревизия. Передавайте текущую ревизию в PUT /templates/:id/draft. Если другой редактор сохранил изменения раньше, SendHQ вернёт 409; перезагрузите черновик, прежде чем перезаписывать его.

Предпросмотр, тест, публикация

1. Отрендерите шаблон на репрезентативных тестовых данных.
2. Устраните все найденные ошибки.
3. Отправьте тестовый снимок на адрес, которым вы управляете.
4. Опубликуйте именно этот черновик как неизменяемый релиз.

Отправка по ключу

{
  "from": "hello@example.com",
  "to": [
    "customer@example.net"
  ],
  "template": {
    "key": "account-welcome",
    "data": {
      "first_name": "Asha"
    }
  }
}

Для отправки персонализированного шаблона нужен ровно один получатель в To и никаких Cc или Bcc. Для индивидуальных получателей используйте эндпоинт пакетной отправки.

Происхождение

Каждая отправка по шаблону фиксирует шаблон, релиз, версию компилятора и хеш отрендеренного содержимого, чтобы любое письмо из истории можно было связать с породившим его содержимым.