القوالب المستضافة

دورة الحياة

للقالب معرّف ومفتاح ثابتان، ومسودة واحدة قابلة للتعديل، وصفر أو أكثر من الإصدارات المنشورة غير القابلة للتعديل، ودورة حياة نشطة أو مؤرشفة. تمنع الأرشفة عمليات الإرسال الجديدة بالمفتاح دون حذف الإصدارات السابقة أو بيانات الاستخدام.

المتغيرات

صرّح بالمتغيّرات مع مفاتيحها وأنواعها وكونها مطلوبة وقيمها الافتراضية الاختيارية. يخفق التوليد بـ 422 عندما لا تستوفي البيانات المقدَّمة العقد المنشور. تُهرَّب (escape) القيم المُدرَجة بحسب السياق.

الحفظ التلقائي المتفائل

تحمل كل مسودة رقم مراجعة. أرسل المراجعة الحالية إلى PUT /templates/:id/draft. إذا حفظ محرّر آخر أولًا، تُعيد SendHQ 409؛ فأعد التحميل قبل الكتابة فوق التغييرات.

المعاينة والاختبار والنشر

1. ولِّد المخرجات ببيانات عيّنة تمثيلية.
2. عالج كل نتيجة من نوع خطأ.
3. أرسل لقطة اختبارية إلى عنوان تتحكم فيه.
4. انشر المسودة نفسها كما هي بوصفها إصدارًا غير قابل للتعديل.

الإرسال بالمفتاح

{
  "from": "hello@example.com",
  "to": [
    "customer@example.net"
  ],
  "template": {
    "key": "account-welcome",
    "data": {
      "first_name": "Asha"
    }
  }
}

يتطلب الإرسال المخصّص بالقالب مستلِمًا واحدًا بالضبط في To ودون Cc أو Bcc. استخدم نقطة نهاية الدفعات لمستلِمين بمحتوى مخصّص لكل منهم.

المصدر

يسجّل كل إرسال قائم على قالب القالبَ والإصدار وإصدار المُصرِّف (compiler) وتجزئة المحتوى المولَّد، بحيث يمكن تتبّع أي رسالة سابقة إلى المحتوى الذي أنتجها.