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

Comunicaciones

Detalle

GET/comm/plantillas/:tkPlantilla

Permite obtener el detalle de una plantilla de correo específica registrada en el sistema.

Parámetros

NombreTipoValidaciónDescripción
tkPlantillavarcharRequeridoCódigo token que corresponde a una plantilla de correos o sms registrada en el sistema.
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.

Respuesta

NombreTipoDescripción
tkPlantillaUUIDCódigo token que corresponde a una plantilla de correos o sms registrada en el sistema.
descripcionStringContiene una descripción que hace referencia al tipo de plantilla.
asuntoStringContiene le título del correo, es decir, el asunto que esté tendrá.
cuerpoStringContiene el cuerpo del correo, la plantilla como tal.
tipoStringIndica a que tipo de plantillas pertenece la plantilla.
tipoStringIndica a que tipo de plantillas pertenece la plantilla 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.
esPropiaNumberIndica si la plantilla es propia del usuario.
anexosArrayLista de archivos adjuntos.
anexos.archivoRealStringNombre real del archivo adjunto.
anexos.urlStringURL para descargar el archivo adjunto.

Solicitud

Ejemplo de solicitud

curl --request GET 'https://api.upnify.com/v4/comm/plantillas/00000000-0000-4000-8000-000000000010?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",
    "cuerpo": "valor-cuerpo",
    "tipo": "valor-tipo",
    "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",
    "esPropia": 0,
    "anexos": [
      {
        "archivoReal": "valor-anexos.archivoReal",
        "url": "valor-anexos.url"
      }
    ]
  }
]