Upnify Documentación API
CRM · /comm/plantillas

Comunicaciones

Lista

GET/comm/plantillas

Permite obtener la lista de las plantillas de correos y sms registradas en el sistema.

Parámetros

NombreTipoValidaciónDescripción
tkPlantillavarcharCódigo token que identifica de forma única al recurso relacionado.
tkUsuarioBuscarvarcharCódigo token que identifica de forma única al recurso relacionado.
tipoPlantillaintCódigo que indica el tipo de plantillas a listar.
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.
compartidasIntegerPermite listar las plantillas compartidas con la empresa o el grupo delo usuario de la sesión.

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?tipoPlantilla=1&compartidas=1&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"
  }
]