Listar la biblioteca de plantillas

GET/v1/template-catalog

Para desarrolladores

Descripción

Devuelve la biblioteca de plantillas: diseños terminados que se ofrecen como punto de partida, con su categoría, su título y su miniatura.

Para ver el documento completo de uno sin copiarlo, use GET /v1/template-catalog/{category}/{name}. Para crear una plantilla a partir de uno, envíe su slug en catalog_slug a POST /v1/mail-templates. La copia trae el documento completo de la plantilla, que después se lee y se modifica como el de cualquier otra; ver Plantillas por API.

Guía relacionada

• Plantillas por API — Cree y edite plantillas desde su integración.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope templates:read. Formato: Bearer <API_KEY>.

X-Instance-Slugstringheaderobligatorio

Identificador de su instancia. Ver Autenticación.

Response

200 OKDevuelve todos los elementos en data. Cada elemento tiene los campos que siguen.

slugstringsiempre presente

Identificador de la plantilla, con la forma <categoría>/<nombre>. Se envía como catalog_slug al crear una plantilla.

categorystringsiempre presente

Categoría de la plantilla.

titlestringsiempre presente

Título para mostrar.

thumbnail_urlstring | nullsiempre presente

URL de la miniatura. null si la plantilla no tiene una.

Nota

• La lista no se pagina: viene completa en data, ordenada por categoría y nombre, y pagination es null. Detalle del formato de colección en Paginación y formato de respuesta.

Request

curl -X GET "https://$API_HOST/v1/template-catalog" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"

Response

{
"data": [
  {
    "slug": "holidays/black-friday",
    "category": "holidays",
    "title": "Black Friday",
    "thumbnail_url": "https://static.example.com/mail-templates/catalog-thumbs/holidays/black-friday-694e7649.jpg"
  },
  {
    "slug": "events-education/webinar-classic",
    "category": "events-education",
    "title": "Webinar",
    "thumbnail_url": null
  }
],
"pagination": null
}