API

テンプレートを更新する

メタデータはその場で更新されます。公開済みテンプレートの本文に触れると、新しい下書きが作られます。

PATCHapi.openemail.uk/templates/{id}

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

PATCH /templates/{id}

メタデータはその場で更新されます。公開済みテンプレートの本文に触れると、新しい下書きが作られます。

例

templates:write が必要です。name、description、status はメタデータです。subject、document、html、slots、props、engine は本文であり、このいずれかを送ることがバージョンを作る行為です。

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  }'

レスポンス

{  "object": "template",  "id": "tpl_9c1f0a4b7e05d3862c1f0a44",  "publishedVersion": 3,  "latestVersion": 5,  "latest": { "object": "template_version", "version": 5, "state": "draft", "publishedAt": null }}

新しい下書きは送信できず、稼働中のものは何も動いていません。公開するまで、送信はバージョン 3 を解決し続けます。編集がその場で行われない理由はまさにこれです。

expectedVersion は編集前に読んだバージョンです。これを渡せば、並行編集は黙った上書きではなく 409 version_conflict になります。省略すると最後の書き込みが勝ちます。1 人が 1 つのタブで作業するなら問題なく、スクリプトにとっては誤りです。

status: "archived" は、テンプレートを削除せずに一覧から外します。アーカイブされたテンプレートも、それを名指しする送信では依然として解決されます。アーカイブは片付けであって、停止スイッチではありません。