Ugrás a dokumentációra
API

Sablon frissítése

A metaadatot helyben foltozzuk. Egy közzétett sablon törzséhez nyúlva új piszkozat születik.

PATCHapi.openemail.uk/templates/{id}

A valódi hívást futtatja le a munkaterületén, a saját kulcsával.

PATCH /templates/{id}

A metaadatot helyben foltozzuk. Egy közzétett sablon törzséhez nyúlva új piszkozat születik.

Példa

templates:write szükséges hozzá. A name, a description és a status metaadat; a subject, a document, a html, a slots, a props és az engine a törzs, és bármelyikük elküldése ver egy verziót.

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  }'
Válasz
{  "object": "template",  "id": "tpl_9c1f0a4b7e05d3862c1f0a44",  "publishedVersion": 3,  "latestVersion": 5,  "latest": { "object": "template_version", "version": 5, "state": "draft", "publishedAt": null }}

Az új piszkozat nem küldhető, és semmi élő nem mozdult: a küldések továbbra is a 3. verziót oldják fel, amíg közzé nem teszed. Pontosan ezért nem helyben történik a szerkesztés.

Az expectedVersion az a verzió, amelyet szerkesztés előtt beolvastál. Add meg, és egy párhuzamos szerkesztés 409 version_conflict lesz a csendes felülírás helyett; hagyd ki, és az utolsó írás nyer, ami egy ember egy fülén rendben van, egy szkriptnél viszont hibás.

A status: "archived" kiveszi a sablont a listából anélkül, hogy törölné. Az archivált sablon továbbra is feloldódik annak a küldésnek, amely megnevezi. Az archiválás rendrakás, nem vészleállító.