Saltar al contenido

Plantillas

Crea plantillas con variables en el panel de Vemudo, publícalas por versiones y úsalas desde la API con templateId y variables.

Por Equipo Vemudo · Actualizado el

Una plantilla es un asunto, un HTML y un texto con variables que rellenas en cada envío. Se editan en el panel, se publican por versiones y se usan desde la API por su alias o su id.

Sintaxis

Las plantillas usan una variante restringida de Handlebars:

html
<h1>Hola {{nombre}}</h1>
<p>Tu pedido {{pedido.numero}} está en camino.</p>
{{#if envioGratis}}
<p>Envío gratis.</p>
{{/if}}
<ul>
  {{#each lineas}}
  <li>{{cantidad}} × {{nombre}}</li>
  {{/each}}
</ul>
  • Variables: {{nombre}}, con rutas ({{cliente.nombre}}) y listas ({{#each lineas}}).
  • Condiciones y bucles: if, unless, each, with y lookup.
  • En el HTML el valor se escapa para que no pueda inyectar código. En el asunto y en el texto se inserta tal cual.
  • No se admiten parciales ({{> otra}}), decoradores ni otros helpers: la plantilla es contenido, no código.

Vemudo detecta las variables de cada versión y te las enseña en el panel. Un error de sintaxis se muestra con su línea (por ejemplo, un bloque sin cerrar) sin repetir los datos que hubieras puesto.

Borradores y versiones

  • Cada plantilla tiene un alias (por ejemplo bienvenida) que usarás desde la API.
  • Los cambios se guardan en un borrador. Al publicar, el borrador se convierte en una versión inmutable. Para cambiarla, creas un nuevo borrador y publicas otra versión.
  • Para publicar hacen falta un asunto y un HTML que no estén vacíos y que compilen.
  • Desde la API solo se ven y se usan versiones publicadas; los borradores nunca salen.
  • El panel permite una vista previa y un envío de prueba a los miembros de tu organización.
  • Límites: hasta 200 plantillas por organización y 200 versiones por plantilla.

Enviar con una plantilla

bash
curl -X POST https://api.vemudo.com/v1/emails \
  -H "Authorization: Bearer $VEMUDO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "[email protected]",
    "templateId": "bienvenida",
    "variables": { "nombre": "Lucía" }
  }'
  • templateId: alias o id de la plantilla. No se puede combinar con html ni text.
  • templateVersion: una versión publicada concreta. Si no la indicas, se usa la publicada más alta.
  • variables: un objeto JSON de hasta 32 KB y 10 niveles de profundidad. No admite las claves __proto__, constructor ni prototype.
  • subject: opcional; si lo envías, sustituye al asunto de la plantilla (y en este caso no admite variables).

También funciona en el envío por lotes, donde cada elemento puede usar una plantilla distinta.

Consultar plantillas por API

bash
curl https://api.vemudo.com/v1/templates \
  -H "Authorization: Bearer $VEMUDO_API_KEY"

curl "https://api.vemudo.com/v1/templates/bienvenida?version=2" \
  -H "Authorization: Bearer $VEMUDO_API_KEY"

GET /v1/templates lista las plantillas que tienen alguna versión publicada, con su versión activa y las variables que espera. GET /v1/templates/{idOrAlias} devuelve el asunto, el HTML y el texto de la versión publicada más alta, o de ?version=N. Necesitas scope read o full.

Errores de plantilla

RespuestaCódigoCausa
422template_not_foundNo existe o no es de tu organización. En un lote, indica el índice.
422template_not_publishedNo tiene ninguna versión publicada.
422template_render_failedEl render falló. errors[] indica la parte (subject, html o text) y la línea, sin los valores.
422template_render_too_largeEl resultado supera 512 KB de HTML o 256 KB de texto.