Saltar al contenido principal

Obtener una plantilla de email

GET/v1/mail-templates/{template_id}

Descripción​

Retorna una plantilla por su id.

Las plantillas se crean y editan desde el panel: esta API expone solo lectura, para resolver un template_id antes de un envío.

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope templates:read. Formato: Bearer FD.<key_id>.<token>.
X-Instance-Slugstringheaderobligatorio

Request​

Path params:

template_idinteger
Identificador de la plantilla.

Response​

200 OKDevuelve un objeto con los campos que siguen.
idintegerobligatorio
Identificador de la plantilla.
namestringobligatorio
Nombre de la plantilla.
subjectstring | null
Asunto del email.
statusstring, enum: `draft | public`obligatorio
Una plantilla en draft no se puede usar en un envío.
descriptionstring | null
Descripción libre.
providerstring, enum: `bee | ckeditor`obligatorio
Editor de contenido con el que se creó.
htmlstring | null
Contenido HTML. Solo lo devuelve esta consulta: el listado lo omite.
configobject | null
Configuración JSON del editor. Solo lo devuelve esta consulta: el listado lo omite.
created_atstring (date-time)obligatorio
—
updated_atstring (date-time)obligatorio
—

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!",
"status": "draft",
"description": null,
"provider": "bee",
"html": "<html><body><h1>Welcome!</h1></body></html>",
"config": null,
"created_at": "2026-05-08T14:22:31Z",
"updated_at": "2026-05-08T14:22:31Z"
}