Upnify Documentación API
CRM · /comm/plantillas/:tkPlantilla/:previsualizar

Comunicaciones

Previsualizar plantilla

GET/comm/plantillas/:tkPlantilla/:previsualizar

Obtiene una plantilla para previsualización.

Parámetros

NombreTipoValidaciónDescripción
tkPlantillavarcharRequeridoCódigo token de la ruta tkPlantilla.
tkUsuarioBuscarvarcharCódigo token que identifica de forma única al recurso relacionado.
tipoPlantillaintValor de tipoPlantilla utilizado por la operación.
textovarcharTexto utilizado para filtrar los resultados.
compartidoConintValor de compartidoCon utilizado por la operación.
appvarcharValor de app utilizado por la operación.
paginaintNúmero de página que se desea consultar.
cantidadRegistrosintCantidad máxima de registros que devuelve la consulta.
previsualizarStringRequeridoCódigo token de la ruta previsualizar.

Respuesta

NombreTipoDescripción
tkPlantillaUUIDCódigo token que corresponde a una plantilla de correos registrada en el sistema.
descripcionStringContiene una descripción que hace referencia al tipo de plantilla de correo.
asuntoStringContiene le título del correo, es decir, el asunto que esté tendrá.
tipoStringIndica si la plantilla es para correo, sms o whatsapp.
tipoTextoStringIndica si la plantilla es para correo, sms o whatsapp con texto.
compartirStringIndica a qué grupo se encuentra compartida la plantilla.
compartirTextoStringIndica a qué grupo se encuentra compartida la plantilla con texto.
tkGrupoUUIDCódigo token que corresponde a un grupo de usuarios.
grupoStringContiene el nombre del grupo de usuarios.
tkUsuarioStringCódigo token que corresponde a un usuario.
ejecutivoStringContiene el nombre del ejecutivo que envía el correo.
inicialesStringContiene las iniciales del nombre del ejecutivo.

Solicitud

Ejemplo de solicitud

curl --request GET 'https://api.upnify.com/v4/comm/plantillas/00000000-0000-4000-8000-000000000010/valor-previsualizar?texto=valor-texto&pagina=1&cantidadRegistros=50' \
  --header 'token: 00000000-0000-4000-8000-000000000001'

Respuesta

Ejemplo de respuesta

JSON
[
  {
    "tkPlantilla": "00000000-0000-4000-8000-000000000010",
    "descripcion": "valor-descripcion",
    "asunto": "valor-asunto",
    "tipo": "valor-tipo",
    "tipoTexto": "valor-tipoTexto",
    "compartir": "valor-compartir",
    "compartirTexto": "valor-compartirTexto",
    "tkGrupo": "00000000-0000-4000-8000-000000000010",
    "grupo": "valor-grupo",
    "tkUsuario": "00000000-0000-4000-8000-000000000010",
    "ejecutivo": "valor-ejecutivo",
    "iniciales": "valor-iniciales"
  }
]