مرجع API
قالبهای میزبانیشده
محتوای قابلاستفاده مجدد را پیشنویس، رندر، آزمایش، نسخهبندی، منتشر و ارسال کنید.
هیچ عملیاتی با این فیلتر مطابقت ندارد.
GET
کلید API/templatesفهرست قالبهای میزبانیشده
فهرست قالبهای میزبانیشده
curl https://sendhq.cc/api/v1/templates \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}POST
کلید API/templatesساخت قالب میزبانیشده
ساخت قالب میزبانیشده
curl https://sendhq.cc/api/v1/templates \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Account welcome","key":"account-welcome","starter":"welcome"}'{
"template": {
"id": "tmpl_…",
"key": "account-welcome"
}
}GET
کلید API/templates/:idدریافت پیشنویسها، نسخههای منتشرشده و میزان استفاده
دریافت پیشنویسها، نسخههای منتشرشده و میزان استفاده
curl https://sendhq.cc/api/v1/templates/id_value \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"template": {
"id": "tmpl_…"
},
"versions": [],
"draft": null,
"activeVersion": null,
"usage": []
}PUT
کلید API/templates/:id/draftذخیره خودکار پیشنویس قالب
ذخیره خودکار پیشنویس قالب
curl https://sendhq.cc/api/v1/templates/id_value/draft \
-X PUT \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"revision":1,"name":"Account welcome","subjectTemplate":"Welcome, {{first_name}}","htmlTemplate":"<h1>Welcome, {{first_name}}</h1>","textTemplate":"Welcome, {{first_name}}","variables":[{"key":"first_name","type":"string","required":true}],"sampleData":{"first_name":"Asha"}}'{
"draft": {
"id": "tmplv_…",
"revision": 2
}
}POST
کلید API/templates/:id/draftساخت پیشنویس جدید از نسخه منتشرشده
ساخت پیشنویس جدید از نسخه منتشرشده
curl https://sendhq.cc/api/v1/templates/id_value/draft \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"draft": {
"id": "tmplv_…",
"revision": 1
}
}POST
کلید API/templates/:id/renderرندر خروجی دقیق سرور
رندر خروجی دقیق سرور
curl https://sendhq.cc/api/v1/templates/id_value/render \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"data":{"first_name":"Asha"}}'{
"subject": "Welcome, Asha",
"html": "<h1>Welcome, Asha</h1>",
"text": "Welcome, Asha",
"findings": []
}POST
کلید API/templates/:id/testارسال یک snapshot آزمایشی
ارسال یک snapshot آزمایشی
curl https://sendhq.cc/api/v1/templates/id_value/test \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"to":["owner@example.com"],"from":"hello@example.com","data":{"first_name":"Asha"}}'{
"id": "em_…",
"isTest": true
}POST
کلید API/templates/:id/publishانتشار یک نسخه تغییرناپذیر از قالب
انتشار یک نسخه تغییرناپذیر از قالب
curl https://sendhq.cc/api/v1/templates/id_value/publish \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"version": {
"id": "tmplv_…",
"state": "published"
}
}POST
کلید API/templates/:id/archiveبایگانی قالب
بایگانی قالب
curl https://sendhq.cc/api/v1/templates/id_value/archive \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"template": {
"id": "tmpl_…",
"lifecycle": "archived"
}
}POST
کلید API/templates/:id/restoreبازیابی قالب بایگانیشده
بازیابی قالب بایگانیشده
curl https://sendhq.cc/api/v1/templates/id_value/restore \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"template": {
"id": "tmpl_…",
"lifecycle": "active"
}
}