Templates: Rutas

Run Commands

El punto de entrada único para los templates. Envía de 1 a 10 comandos en una solicitud y obtén un resultado por comando.

POSThttps://g.sendcorex.com/v1/template
i

El mismo sobre que Domains, Senders y Contacts. Las páginas debajo de esta documentan cada comando.

i

Los errores se informan por comando. Un comando que falla no detiene a los demás, y el estado HTTP sigue siendo 200.

Parámetros del cuerpo

  • commandsobject[]obligatorio

    De 1 a 10 comandos, ejecutados en orden. El cuerpo completo puede tener hasta 1 MB.

  • commands[].commandstringobligatorio

    list_templates, get_template, render_template, create_template, update_template, delete_template, list_template_versions o restore_template_version.

  • commands[].argsobjectopcional

    Los argumentos del comando. Cualquier valor puede ser un $ref al resultado de un comando anterior.

  • commands[].idstringopcional

    Tu propio identificador para el resultado. Por defecto, el índice ("0", "1"…). Obligatorio si quieres usar $ref.

Inicio 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);
}

Respuesta

{
  "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 de la respuesta

  • type

    Siempre SUCCESS cuando la solicitud en sí fue aceptada.

  • results[].command

    El comando que produjo este resultado.

  • results[].id

    El id que enviaste, o el índice del comando.

  • results[].type

    SUCCESS o ERROR.

  • results[].took_ms

    Tiempo que tardó el comando dentro del servidor.

  • results[].data

    La salida del comando. Solo está presente cuando type es SUCCESS.

  • results[].code / message

    El error. Solo está presente cuando type es ERROR.

Autenticación

Usa la API key que creas en el dashboard, en Developers → API Keys, con los scopes que necesitan los comandos.

  • Authorization

    Envía Authorization: <api key> o Authorization: Bearer <api key>.

  • template:read

    list_templates, get_template, render_template y list_template_versions.

  • template:create

    create_template.

  • template:update

    update_template y restore_template_version.

  • template:delete

    delete_template.

  • Tokens de mailbox

    El token del webmail no funciona aquí. Se rechaza con WRONG_CREDENTIAL_TYPE.

  • IPs permitidas

    Si la key tiene una lista de IPs permitidas, las solicitudes desde otras IPs reciben 403 IP_NOT_ALLOWED.

Encadenar con $ref

Crea un template y renderízalo en la misma solicitud para comprobar el 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 y caché

  • 15 solicitudes / segundo

    Por IP + API key. Por encima, HTTP 429 con un header Retry-After.

  • 15 simultáneas

    Como máximo 15 solicitudes procesándose al mismo tiempo, por IP + API key.

  • Por comando, por cuenta

    create_template 30/min · update_template 60/min · restore_template_version 20/min · delete_template 30/min. Por encima, ese comando responde RATE_LIMITED.

  • Caché de lectura: 1,5 s

    La misma lectura dentro de 1,5 segundos devuelve el mismo resultado. Cualquier escritura en la ruta la invalida.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 400INVALID_JSON

    El cuerpo no es {"commands":[...]} o pesa más de 1 MB.

  • 400INVALID_ARGS

    La solicitud no tiene comandos o tiene más de 10.

  • 401MISSING_AUTH_HEADER

    No se envió ningún header Authorization.

  • 401INVALID_API_KEY

    La API key no existe, fue revocada o se desactivó en el dashboard.

  • 401API_KEY_EXPIRED

    La API key superó la fecha de expiración definida en el dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Se envió un token de mailbox. La Templates API necesita una API key del dashboard.

  • 403IP_NOT_ALLOWED

    La solicitud vino de una IP que no está entre las IPs permitidas de la key.

  • 403ACCOUNT_BLOCKED

    La cuenta está bloqueada.

  • 403MISSING_SCOPE

    La key no tiene ningún scope `template:*`, así que no se puede ejecutar ningún comando.

  • 429RATE_LIMITED

    Más de 15 solicitudes/s o 15 simultáneas para la misma IP + API key. Espera el número de segundos indicado en Retry-After.

  • 503AUTH_UNAVAILABLE

    La autenticación no está disponible temporalmente. Inténtalo de nuevo.

  • CMDUNKNOWN_COMMAND

    El nombre del comando no existe.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.