Templates: Rute
Run Commands
Satu-satunya titik masuk untuk template. Kirim 1 hingga 10 perintah dalam satu request dan dapatkan satu hasil per perintah.
https://g.sendcorex.com/v1/templateEnvelope-nya sama dengan Domains, Senders, dan Contacts. Halaman-halaman di bawah ini mendokumentasikan setiap perintah.
Error dilaporkan per perintah. Perintah yang gagal tidak menghentikan perintah lain, dan status HTTP tetap 200.
Parameter body
commandsobject[]wajib1 hingga 10 perintah, dijalankan berurutan. Seluruh body bisa berukuran hingga 1 MB.
commands[].commandstringwajiblist_templates,get_template,render_template,create_template,update_template,delete_template,list_template_versions, ataurestore_template_version.commands[].argsobjectopsionalArgumen perintah. Nilai apa pun bisa berupa
$refke hasil perintah sebelumnya.commands[].idstringopsionalPengenal Anda sendiri untuk hasilnya. Default-nya indeks (
"0","1"…). Wajib jika Anda ingin memakai$ref.
Mulai cepat
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/template',
{
commands: [
{
command: "list_templates",
id: "all"
},
{
command: "render_template",
id: "preview",
args: {
template_id: "html_5f2c8a10-3d4e-4b6f-9a71-2c8e0d4b7a93",
variables: {
first_name: "Ana",
plan: "Pro"
}
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
for (const result of response.data.results) {
if (result.type !== 'SUCCESS') console.error(result.id, result.code, result.message);
else console.log(result.id, result.data);
}Respons
{
"type": "SUCCESS",
"results": [
{
"command": "list_templates",
"id": "all",
"type": "SUCCESS",
"took_ms": 6,
"data": {
"templates": [
{
"template_id": "html_5f2c8a10-3d4e-4b6f-9a71-2c8e0d4b7a93",
"type": "html",
"name": "Welcome email",
"reference": "K7Q2M9XR4T",
"preview": null,
"has_html": true,
"html_size": 248,
"editable": true,
"created_at": "2026-10-21T04:02:11.310Z",
"updated_at": "2026-10-21T04:15:40.902Z"
},
{
"template_id": "unlayer_1284",
"type": "unlayer",
"name": "October newsletter",
"reference": "B3VN8QK1ZT",
"preview": "https://res.cloudinary.com/dmg04ffuy/image/upload/v1760000000/previews/oct_newsletter.png",
"has_html": true,
"html_size": 48211,
"editable": false,
"created_at": "2026-10-01T09:12:00.000Z",
"updated_at": "2026-10-18T16:40:22.118Z"
}
]
}
},
{
"command": "render_template",
"id": "preview",
"type": "SUCCESS",
"took_ms": 3,
"data": {
"template_id": "html_5f2c8a10-3d4e-4b6f-9a71-2c8e0d4b7a93",
"subject": "Welcome to Acme, Ana",
"html": "<!doctype html><html><body style=\"font-family:Arial,sans-serif\"><h1>Welcome, Ana!</h1><p>Your Pro plan is ready.</p><p><a href=\"https://acme.com/start\">Get started</a></p></body></html>",
"text": "Welcome, Ana! Your Pro plan is ready. Get started: https://acme.com/start",
"missing_variables": []
}
}
]
}Field respons
typeSelalu
SUCCESSjika request itu sendiri diterima.results[].commandPerintah yang menghasilkan hasil ini.
results[].ididyang Anda kirim, atau indeks perintah.results[].typeSUCCESSatauERROR.results[].took_msWaktu yang dibutuhkan perintah di dalam server.
results[].dataOutput perintah. Hanya ada jika
typebernilaiSUCCESS.results[].code / messageError-nya. Hanya ada jika
typebernilaiERROR.
Autentikasi
Gunakan API key yang Anda buat di dashboard, di Developers → API Keys, dengan scope yang dibutuhkan perintah.
AuthorizationKirim
Authorization: <api key>atauAuthorization: Bearer <api key>.template:readlist_templates,get_template,render_template, danlist_template_versions.template:createcreate_template.template:updateupdate_templatedanrestore_template_version.template:deletedelete_template.Token mailboxToken webmail tidak berfungsi di sini. Token itu ditolak dengan
WRONG_CREDENTIAL_TYPE.IP yang diizinkanJika key memiliki allowlist IP, request dari IP lain mendapat
403 IP_NOT_ALLOWED.
Merangkai dengan $ref
Buat template dan render dalam request yang sama untuk memeriksa hasilnya.
create_template → render_template
{
"commands": [
{
"command": "create_template",
"id": "new",
"args": {
"name": "Welcome email",
"subject": "Welcome to Acme, {{first_name}}",
"html": "<!doctype html><html><body style=\"font-family:Arial,sans-serif\"><h1>Welcome, {{first_name}}!</h1><p>Your {{plan}} plan is ready.</p><p><a href=\"https://acme.com/start\">Get started</a></p></body></html>"
}
},
{
"command": "render_template",
"args": {
"template_id": {
"$ref": "new",
"path": "template_id"
},
"variables": {
"first_name": "Ana",
"plan": "Pro"
}
}
}
]
}Rate limit dan cache
15 request / detikPer IP + API key. Jika lebih, HTTP 429 dengan header
Retry-After.15 bersamaanPaling banyak 15 request diproses pada saat yang sama, per IP + API key.
Per perintah, per akuncreate_template30/menit ·update_template60/menit ·restore_template_version20/menit ·delete_template30/menit. Jika lebih, perintah itu menjawabRATE_LIMITED.Cache baca: 1,5 dtkPembacaan yang sama dalam 1,5 detik mengembalikan hasil yang sama. Penulisan apa pun di rute ini akan menghapusnya.
Error
Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.
- 400
INVALID_JSONBody bukan {"commands":[...]} atau lebih besar dari 1 MB.
- 400
INVALID_ARGSRequest tidak memiliki perintah atau lebih dari 10.
- 401
MISSING_AUTH_HEADERTidak ada header Authorization yang dikirim.
- 401
INVALID_API_KEYAPI key tidak ada, telah dicabut, atau dinonaktifkan di dashboard.
- 401
API_KEY_EXPIREDAPI key telah melewati tanggal kedaluwarsa yang diatur di dashboard.
- 401
WRONG_CREDENTIAL_TYPEYang dikirim adalah token mailbox. Templates API membutuhkan API key dari dashboard.
- 403
IP_NOT_ALLOWEDRequest berasal dari IP yang tidak termasuk IP yang diizinkan untuk key ini.
- 403
ACCOUNT_BLOCKEDAkun diblokir.
- 403
MISSING_SCOPEKey tidak memiliki scope `template:*`, jadi tidak ada perintah yang bisa dijalankan.
- 429
RATE_LIMITEDLebih dari 15 request/dtk atau 15 bersamaan untuk IP + API key yang sama. Tunggu sejumlah detik yang ada di Retry-After.
- 503
AUTH_UNAVAILABLEAutentikasi sementara tidak tersedia. Coba lagi.
- CMD
UNKNOWN_COMMANDNama perintah tidak ada.
- CMD
INTERNALError server. Detailnya hanya ditulis ke log server.