Templates : Routes

Run Commands

Le point d'entrée unique pour les templates. Envoyez de 1 à 10 commandes en une requête et obtenez un résultat par commande.

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

Même enveloppe que Domains, Senders et Contacts. Les pages sous celle-ci documentent chaque commande.

i

Les erreurs sont signalées par commande. Une commande qui échoue n'arrête pas les autres, et le statut HTTP reste 200.

Paramètres du corps

  • commandsobject[]obligatoire

    1 à 10 commandes, exécutées dans l'ordre. Le corps entier peut faire jusqu'à 1 MB.

  • commands[].commandstringobligatoire

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

  • commands[].argsobjectfacultatif

    Les arguments de la commande. Toute valeur peut être un $ref vers le résultat d'une commande précédente.

  • commands[].idstringfacultatif

    Votre propre identifiant pour le résultat. Par défaut, l'index ("0", "1"…). Obligatoire si vous voulez utiliser $ref.

Démarrage rapide

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

Réponse

{
  "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": []
      }
    }
  ]
}

Champs de la réponse

  • type

    Toujours SUCCESS lorsque la requête elle-même a été acceptée.

  • results[].command

    La commande qui a produit ce résultat.

  • results[].id

    L'id que vous avez envoyé, ou l'index de la commande.

  • results[].type

    SUCCESS ou ERROR.

  • results[].took_ms

    Le temps passé par la commande dans le serveur.

  • results[].data

    La sortie de la commande. Présente uniquement lorsque type vaut SUCCESS.

  • results[].code / message

    L'erreur. Présente uniquement lorsque type vaut ERROR.

Authentification

Utilisez l'API key que vous créez dans le dashboard, sous Developers → API Keys, avec les scopes dont les commandes ont besoin.

  • Authorization

    Envoyez Authorization: <api key> ou Authorization: Bearer <api key>.

  • template:read

    list_templates, get_template, render_template et list_template_versions.

  • template:create

    create_template.

  • template:update

    update_template et restore_template_version.

  • template:delete

    delete_template.

  • Tokens de mailbox

    Le token du webmail ne fonctionne pas ici. Il est rejeté avec WRONG_CREDENTIAL_TYPE.

  • IP autorisées

    Si la key a une liste d'IP autorisées, les requêtes provenant d'autres IP reçoivent 403 IP_NOT_ALLOWED.

Enchaîner avec $ref

Créez un template et rendez-le dans la même requête pour vérifier le résultat.

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 et cache

  • 15 requêtes / seconde

    Par IP + API key. Au-delà, HTTP 429 avec un header Retry-After.

  • 15 simultanées

    Au maximum 15 requêtes traitées en même temps, par IP + API key.

  • Par commande, par compte

    create_template 30/min · update_template 60/min · restore_template_version 20/min · delete_template 30/min. Au-delà, cette commande répond RATE_LIMITED.

  • Cache de lecture : 1,5 s

    La même lecture à moins de 1,5 seconde d'intervalle renvoie le même résultat. Toute écriture sur la route le vide.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 400INVALID_JSON

    Le corps n'est pas {"commands":[...]} ou dépasse 1 MB.

  • 400INVALID_ARGS

    La requête ne contient aucune commande ou plus de 10.

  • 401MISSING_AUTH_HEADER

    Aucun header Authorization n'a été envoyé.

  • 401INVALID_API_KEY

    L'API key n'existe pas, a été révoquée ou a été désactivée dans le dashboard.

  • 401API_KEY_EXPIRED

    L'API key a dépassé la date d'expiration définie dans le dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Un token de mailbox a été envoyé. La Templates API nécessite une API key du dashboard.

  • 403IP_NOT_ALLOWED

    La requête provient d'une IP qui ne figure pas parmi les IP autorisées de la key.

  • 403ACCOUNT_BLOCKED

    Le compte est bloqué.

  • 403MISSING_SCOPE

    La key n'a aucun scope `template:*`, donc aucune commande ne peut s'exécuter.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.

  • 503AUTH_UNAVAILABLE

    L'authentification est temporairement indisponible. Réessayez.

  • CMDUNKNOWN_COMMAND

    Le nom de la commande n'existe pas.

  • CMDINTERNAL

    Erreur serveur. Le détail n'est écrit que dans le log du serveur.