Zur Dokumentation springen
API

Ein Template in der Vorschau ansehen

Genau das HTML, das ein Versand erzeugen würde, ohne es zu versenden.

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

Führt den echten Aufruf gegen Ihren Workspace aus, mit Ihrem eigenen Schlüssel.

POST /templates/{id}/preview

Genau das HTML, das ein Versand erzeugen würde, ohne es zu versenden.

Beispiel

Benötigt templates:read. Ein POST, weil die Werte in einen Body gehören; es wird nichts geschrieben und nichts versendet.

curl
curl -X POST "$OE/templates/order-shipped/preview" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "version": 5, "props": { "orderId": "AC-4192" } }'
Response
{  "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" }]}

Richten Sie Ihre CI hierauf. Eine Template-Änderung, die Ihre Integration kaputtmacht, ist dann ein fehlschlagender Test statt einer verwirrenden E-Mail bei einer Kundin.

Nachsichtig, wo ein Versand streng ist: Eine fehlende Pflicht-Prop wird in warnings gemeldet statt abgelehnt, denn ein Template in der Vorschau ist meist ein Template im Entstehen. Eine UNBEKANNTE Prop ist hier weiterhin ein 422, denn ein Tippfehler ist in jedem Stadium ein Tippfehler.

Ein Entwurf kann in der Vorschau angesehen werden, und dies ist der einzige Pfad, der außerhalb des Veröffentlichens etwas rendert. Lassen Sie version weg, und Sie sehen die Vorschau des Veröffentlichten; nennen Sie eine, um diese Revision in der Vorschau zu sehen, Entwurf eingeschlossen.

JSON, niemals text/html. Das HTML ist ein String in einem Feld, damit ein Client die Antwort parsen kann, bevor er entscheidet, was er damit tut.