Templates: Rotas
Run Commands
O ponto de entrada único para templates. Envie de 1 a 10 comandos em uma requisição e receba um resultado por comando.
https://g.sendcorex.com/v1/templateMesmo envelope de Domains, Senders e Contacts. As páginas abaixo desta documentam cada comando.
Os erros são reportados por comando. Um comando que falha não interrompe os outros, e o status HTTP continua 200.
Parâmetros do corpo
commandsobject[]obrigatório1 a 10 comandos, executados em ordem. O corpo inteiro pode ter até 1 MB.
commands[].commandstringobrigatóriolist_templates,get_template,render_template,create_template,update_template,delete_template,list_template_versionsourestore_template_version.commands[].argsobjectopcionalOs argumentos do comando. Qualquer valor pode ser um
$refpara o resultado de um comando anterior.commands[].idstringopcionalSeu próprio identificador para o resultado. Padrão: o índice (
"0","1"…). Obrigatório se você quiser usar$ref.
Início rápido
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);
}Resposta
{
"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": []
}
}
]
}Campos da resposta
typeSempre
SUCCESSquando a requisição em si foi aceita.results[].commandO comando que gerou este resultado.
results[].idO
idque você enviou, ou o índice do comando.results[].typeSUCCESSouERROR.results[].took_msTempo que o comando levou dentro do servidor.
results[].dataA saída do comando. Só aparece quando
typeéSUCCESS.results[].code / messageO erro. Só aparece quando
typeéERROR.
Autenticação
Use a API key que você cria no dashboard, em Developers → API Keys, com os escopos de que os comandos precisam.
AuthorizationEnvie
Authorization: <api key>ouAuthorization: Bearer <api key>.template:readlist_templates,get_template,render_templateelist_template_versions.template:createcreate_template.template:updateupdate_templateerestore_template_version.template:deletedelete_template.Tokens de mailboxO token do webmail não funciona aqui. Ele é rejeitado com
WRONG_CREDENTIAL_TYPE.IPs permitidosSe a key tem uma allowlist de IPs, requisições de outros IPs recebem
403 IP_NOT_ALLOWED.
Encadeando com $ref
Crie um template e renderize-o na mesma requisição para conferir o resultado.
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 limits e cache
15 requisições / segundoPor IP + API key. Acima disso, HTTP 429 com um header
Retry-After.15 simultâneasNo máximo 15 requisições sendo processadas ao mesmo tempo, por IP + API key.
Por comando, por contacreate_template30/min ·update_template60/min ·restore_template_version20/min ·delete_template30/min. Acima disso, esse comando respondeRATE_LIMITED.Cache de leitura: 1,5 sA mesma leitura dentro de 1,5 segundo retorna o mesmo resultado. Qualquer escrita na rota limpa o cache.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 400
INVALID_JSONO corpo não é {"commands":[...]} ou tem mais de 1 MB.
- 400
INVALID_ARGSA requisição não tem comandos ou tem mais de 10.
- 401
MISSING_AUTH_HEADERNenhum header Authorization foi enviado.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 401
API_KEY_EXPIREDA API key passou da data de expiração definida no dashboard.
- 401
WRONG_CREDENTIAL_TYPEFoi enviado um token de mailbox. A Templates API precisa de uma API key do dashboard.
- 403
IP_NOT_ALLOWEDA requisição veio de um IP que não está nos IPs permitidos da key.
- 403
ACCOUNT_BLOCKEDA conta está bloqueada.
- 403
MISSING_SCOPEA key não tem nenhum escopo `template:*`, então nenhum comando pode rodar.
- 429
RATE_LIMITEDMais de 15 requisições/s ou 15 simultâneas para o mesmo IP + API key. Aguarde o número de segundos em Retry-After.
- 503
AUTH_UNAVAILABLEA autenticação está temporariamente indisponível. Tente de novo.
- CMD
UNKNOWN_COMMANDO nome do comando não existe.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.