Перейти к документации
API

Предпросмотр шаблона

Ровно тот HTML, который дала бы отправка, но без отправки.

POSTapi.openemail.uk/templates/{id}/preview

Выполняет настоящий запрос в вашем рабочем пространстве, с вашим собственным ключом.

POST /templates/{id}/preview

Ровно тот HTML, который дала бы отправка, но без отправки.

Пример

Требует templates:read. Это POST, потому что значения идут в теле; ничего не записывается и ничего не отправляется.

curl
curl -X POST "$OE/templates/order-shipped/preview" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "version": 5, "props": { "orderId": "AC-4192" } }'
Ответ
{  "object": "template_preview",  "templateId": "tpl_9c1f0a4b7e05d3862c1f0a44",  "version": 5,  "subject": "Order AC-4192 is on its way",  "html": "<!DOCTYPE html><html>…</html>",  "text": "Hello there, AC-4192 is on its way.",  "warnings": [{ "code": "unfilled_placeholder", "key": "customer" }]}

Направьте сюда свой CI. Тогда изменение шаблона, ломающее вашу интеграцию, — это упавший тест, а не письмо, озадачившее клиента.

Снисходителен там, где отправка строга: отсутствующее обязательное свойство попадает в warnings, а не отклоняется, потому что шаблон в предпросмотре — это обычно шаблон, который сейчас пишут. НЕИЗВЕСТНОЕ свойство здесь по-прежнему 422, потому что опечатка остаётся опечаткой на любой стадии.

Черновик можно посмотреть в предпросмотре, и это единственный путь, который что-либо отрисовывает вне публикации. Опустите version — увидите то, что опубликовано; назовите версию — увидите ту ревизию, включая черновик.

JSON, никогда не text/html. HTML лежит строкой в поле, чтобы клиент мог разобрать ответ до того, как решит, что с ним делать.