Obtener una plantilla de la biblioteca

GET/v1/template-catalog/{category}/{name}

Para desarrolladores

Descripción

Devuelve una plantilla de la biblioteca con su documento completo en config, el mismo que guarda una copia creada con catalog_slug en POST /v1/mail-templates. No crea nada.

Sirve para ver cómo está armada una plantilla real antes de copiarla, o para tomarla de ejemplo al escribir o modificar un config.

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.

Request

Path params:

categorystringobligatorio

Primera parte del slug de la plantilla, por ejemplo holidays.

namestringobligatorio

Segunda parte del slug, por ejemplo black-friday.

La ruta es el slug tal como lo devuelve GET /v1/template-catalog: holidays/black-friday se lee en /v1/template-catalog/holidays/black-friday.

Response

200 OKDevuelve un objeto con los campos que siguen.

slugstringsiempre presente

Identificador de la plantilla. Se envía como catalog_slug para crear una copia.

categorystringsiempre presente

Categoría de la plantilla.

titlestringsiempre presente

Título de la plantilla.

thumbnail_urlstring | nullsiempre presente

Miniatura de la plantilla; null si no tiene una.

configobjectsiempre presente

Documento completo de la plantilla, descrito en Formato de plantillas.

Errores

Código	Cuándo
404	No existe una plantilla con ese slug en la biblioteca (catalog_template_not_found).

Detalle en Errores genéricos.

Notas

• Leer no copia. Para tener la plantilla en su cuenta, cree una copia con catalog_slug. La copia guarda este mismo config.
• Las imágenes del documento apuntan a la URL completa de la plataforma, igual que en la copia.

Request

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

Response

{
"slug": "holidays/black-friday",
"category": "holidays",
"title": "Black Friday",
"thumbnail_url": "https://storage.googleapis.com/…/black-friday-694e7649.jpg",
"config": {
  "page": {
    "title": "Black Friday",
    "body": {
      "…": "…"
    },
    "rows": [
      "…"
    ]
  }
}
}