Ga direct naar de documentatie
API

Een template bijwerken

Metadata wordt ter plekke gepatcht. De body van een gepubliceerde template aanraken slaat een nieuw concept.

PATCHapi.openemail.uk/templates/{id}

Voert de echte aanroep uit op je workspace, met je eigen sleutel.

PATCH /templates/{id}

Metadata wordt ter plekke gepatcht. De body van een gepubliceerde template aanraken slaat een nieuw concept.

Voorbeeld

Vereist templates:write. name, description en status zijn metadata; subject, document, html, slots, props en engine zijn de body, en een van die meesturen is wat een versie slaat.

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

Het nieuwe concept is niet verzendbaar en er is niets live verschoven: verzendingen blijven versie 3 oplossen tot je publiceert. Dat is de hele reden dat de bewerking niet ter plekke gebeurt.

expectedVersion is de versie die je las voordat je ging bewerken. Geef hem mee en een gelijktijdige bewerking is een 409 version_conflict in plaats van een stille overschrijving; laat hem weg en de laatste schrijver wint, wat prima is voor één persoon in één tabblad en fout voor een script.

status: "archived" haalt een template uit de lijst zonder hem te verwijderen. Een gearchiveerde template lost nog steeds op voor een verzending die hem noemt. Archiveren is opruimen, geen noodrem.