Saltar al contenido principal

Obtener el formato de un tipo de módulo

GET/v1/mail-templates/format/modules/{kind}

Para desarrolladores

Descripción​

Devuelve el formato de un tipo de módulo: su JSON Schema 2020-12, con las definiciones que usa (el tipo y el valor por defecto de cada campo de su descriptor), la clave de su contenido y un módulo completo de ejemplo, listo para agregar a un config.

Sirve para armar o cambiar un bloque sin leer la especificación completa de GET /v1/mail-templates/format, que lista los tipos disponibles en modules.

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:

kindstringobligatorio
Tipo de módulo: el nombre corto (button) o el type completo (fidelizador-modules-button).

Response​

200 OKDevuelve un objeto con los campos que siguen.
kindstringsiempre presente
Nombre corto del tipo de módulo.
typestringsiempre presente
Valor de type de un módulo de este tipo en el documento.
content_keystringsiempre presente
Clave de descriptor donde va el contenido del módulo.
schemaobjectsiempre presente
JSON Schema 2020-12 de un módulo de este tipo, autocontenido: la raíz apunta a su definición y $defs trae todas las que usa. El default de cada campo es el valor con que se guarda cuando el módulo lo omite.
exampleobjectsiempre presente
Un módulo completo y válido de este tipo, con su uuid.

Errores​

CódigoCuándo
404kind no es un tipo de módulo disponible (template_module_not_found).

Detalle en Errores genéricos.

Notas
  • El uuid del ejemplo no se reutiliza. Si agrega el módulo de ejemplo a un documento, dele un uuid nuevo, distinto de todos los del documento.
  • El contenido del módulo es obligatorio. Reemplace el del ejemplo por el suyo.
  • El significado de cada tipo de campo (color, length, url, …) está en la especificación de Formato de plantillas.
Request
curl -X GET "https://$API_HOST/v1/mail-templates/format/modules/button" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"kind": "button",
"type": "fidelizador-modules-button",
"content_key": "button",
"schema": {
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$ref": "#/$defs/module_button",
  "$defs": {
    "module_button": {
      "…": "…"
    },
    "url": {
      "…": "…"
    },
    "color": {
      "…": "…"
    }
  }
},
"example": {
  "uuid": "button-example-1",
  "type": "fidelizador-modules-button",
  "descriptor": {
    "button": {
      "href": "https://example.com",
      "label": "…",
      "…": "…"
    },
    "style": {
      "…": "…"
    },
    "computedStyle": {
      "…": "…"
    }
  }
}
}