Saltar al contenido principal

Obtener una plantilla de email

GET/v1/mail-templates/{template_id}

Para desarrolladores

Descripción​

Devuelve una plantilla por su id.

Además de resolver un template_id antes de un envío, esta API permite crear y editar plantillas en borrador. Publicar, despublicar y eliminar una plantilla se hace desde el panel.

Guía relacionada​

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope templates:read. Formato: Bearer <API_KEY>.
X-Instance-Slugstringheaderobligatorio
Identificador de su instancia. Ver Autenticación.

Request​

Path params:

template_idintegerobligatorio
Identificador de la plantilla.

Response​

200 OKDevuelve un objeto con los campos que siguen.
idintegersiempre presente
Identificador de la plantilla.
namestringsiempre presente
Nombre de la plantilla.
subjectstring | null
Asunto del correo.
preheaderstring | null
Texto que la bandeja de entrada muestra junto al asunto. Ya va incluido en html, como un bloque oculto al comienzo del cuerpo.
statusstring, enum: `draft | public`siempre presente
Una plantilla en draft solo se puede usar en un envío con test_mode: true.
descriptionstring | null
Descripción libre.
providerstring, enum: `fidelizador | bee`siempre presente
Editor de contenido con el que se creó. Una plantilla bee es de un editor que ya no se ofrece: se puede listar, publicar y enviar, pero no editar (template_read_only).
htmlstring | null
Contenido HTML. El listado no lo incluye.
configobject | null
Documento completo del diseño, descrito en Formato de plantillas. El listado no lo incluye. Para cambiar el diseño, modifique este documento y envíelo completo con `PATCH /v1/mail-templates/{template_id}`.
created_atstring (date-time)siempre presente
—
updated_atstring (date-time)siempre presente
—

Errores​

CódigoCuándo
404No existe una plantilla con ese template_id en la instancia (mail_template_not_found).

Detalle en Errores genéricos.

Request
curl -X GET "https://$API_HOST/v1/mail-templates/12" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"id": 12,
"name": "Welcome Email Template",
"subject": "Welcome to Our Service!",
"preheader": "Conoce todo lo que puedes hacer desde el primer día",
"status": "draft",
"description": null,
"provider": "fidelizador",
"html": "<html><body><h1>Welcome!</h1></body></html>",
"config": null,
"created_at": "2026-05-08T14:22:31Z",
"updated_at": "2026-05-08T14:22:31Z"
}