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: los campos de su descriptor con el tipo de cada uno, los valores con que empieza un módulo nuevo de ese tipo 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.
field_typesobjectsiempre presente
Campos de descriptor para este tipo y el tipo de valor de cada uno, con los objetos anidados desplegados. style indica un objeto de propiedades CSS.
defaultsobjectsiempre presente
Valores con que empieza un módulo nuevo de este tipo.
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 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",
"field_types": {
  "button": {
    "href": "url",
    "label": "html",
    "target": "enum:_blank|_self|_parent|_top",
    "style": "style",
    "percWidth": "number",
    "data-color": "string"
  },
  "computedStyle": {
    "hideContentOnDesktop": "boolean",
    "hideContentOnMobile": "boolean",
    "…": "…"
  },
  "hoverStyle": "style",
  "mobileStyle": "style",
  "style": "style"
},
"defaults": {
  "descriptor": {
    "button": {
      "href": "",
      "target": "_blank",
      "style": {
        "background-color": "#0c6cc7",
        "…": "…"
      }
    },
    "…": "…"
  }
},
"example": {
  "uuid": "2693031c-af59-57c1-b3d7-96fed98dfb6d",
  "type": "fidelizador-modules-button",
  "descriptor": {
    "button": {
      "href": "https://example.com",
      "label": "…",
      "…": "…"
    },
    "style": {
      "…": "…"
    },
    "computedStyle": {
      "…": "…"
    }
  }
}
}