Aller à la documentation
API

Mettre à jour un modèle

Les métadonnées sont modifiées sur place. Toucher au corps d'un modèle publié crée un nouveau brouillon.

PATCHapi.openemail.uk/templates/{id}

Exécute le véritable appel sur votre espace de travail, avec votre propre clé.

PATCH /templates/{id}

Les métadonnées sont modifiées sur place. Toucher au corps d'un modèle publié crée un nouveau brouillon.

Exemple

Nécessite templates:write. name, description et status sont des métadonnées ; subject, document, html, slots, props et engine forment le corps, et envoyer l'un d'eux est ce qui crée une version.

curl
curl -X PATCH "$OE/templates/order-shipped" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "html": "<p>Hello {{customer}}, {{orderId}} is on its way.</p>",    "expectedVersion": 4  }'
Réponse
{  "object": "template",  "id": "tpl_9c1f0a4b7e05d3862c1f0a44",  "publishedVersion": 3,  "latestVersion": 5,  "latest": { "object": "template_version", "version": 5, "state": "draft", "publishedAt": null }}

Le nouveau brouillon n'est pas envoyable et rien en production n'a bougé : les envois continuent de résoudre la version 3 jusqu'à ce que vous publiiez. C'est toute la raison pour laquelle la modification ne se fait pas sur place.

expectedVersion est la version que vous avez lue avant de modifier. Fournissez-la et une modification concurrente devient un 409 version_conflict au lieu d'un écrasement silencieux ; omettez-la et la dernière écriture gagne, ce qui convient à une personne dans un onglet et non à un script.

status: "archived" sort un modèle de la liste sans le supprimer. Un modèle archivé se résout encore pour un envoi qui le nomme. L'archivage est un rangement, pas un coupe-circuit.