Prévisualiser un modèle
Exactement le HTML que produirait un envoi, sans l'envoyer.
Exécute le véritable appel sur votre espace de travail, avec votre propre clé.
POST /templates/{id}/preview
Exactement le HTML que produirait un envoi, sans l'envoyer.
Exemple
Nécessite templates:read. Un POST parce que les valeurs passent dans un corps ; rien n'est écrit et rien n'est envoyé.
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" }]}Pointez votre CI dessus. Une modification de modèle qui casse votre intégration devient alors un test qui échoue plutôt qu'un e-mail déroutant chez un client.
Indulgent là où un envoi est strict : une prop obligatoire manquante est signalée dans warnings plutôt que refusée, parce qu'un modèle prévisualisé est en général un modèle en cours d'écriture. Une prop INCONNUE reste un 422 ici, car une faute de frappe est une faute de frappe à toutes les étapes.
Un brouillon peut être prévisualisé, et c'est le seul chemin qui rend quoi que ce soit en dehors de la publication. Omettez version et vous prévisualisez ce qui est publié ; nommez-en une pour prévisualiser cette révision, brouillon compris.
Du JSON, jamais text/html. Le HTML est une chaîne dans un champ, pour qu'un client puisse analyser la réponse avant de décider quoi en faire.