تخطَّ إلى المستندات
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 بدل كتابة صامتة فوق العمل؛ وأغفِله فتفوز آخر كتابة، وهو مقبول لشخص واحد في تبويب واحد وخطأ لسكربت.

يُخرج status: "archived" القالب من القائمة دون حذفه. ويظل القالب المؤرشف قابلاً للحلّ لإرسال يسمّيه. فالأرشفة ترتيب لا مفتاح إيقاف.