Upnify Documentación API
CRM · /clientes/:tk/archivar

Clientes

Archivar

PUT/clientes/:tk/archivar

Permite archivar un cliente. Es decir, ocultar el cliente de la lista de clientes, sin descartarlo.

Parámetros

NombreTipoValidaciónDescripción
tokenvarcharToken de autenticación enviado en el encabezado token.
tkvarcharCódigo token que identifica de forma única al parámetro de ruta tk.
prospectosvarcharLista separada por comas de códigos token de clientes.
tkUsuariovarcharCódigo token que identifica de forma única al recurso relacionado.
tipointPermite archivar o desarchivar un cliente específico.
tkClienteUUIDRequeridoCódigo token que corresponde a un cliente en el sistema, el cual se requiere archivar.

Respuesta

NombreTipoDescripción
codeIntegerProporciona un código de verificación como respuesta.
msgStringProporciona un mensaje descriptivo o razón dependiendo el resultado.
detailsStringContiene el token del nuevo registro creado, el nombre de la variable "tkNombreVariable", deberá coincidir con el nombre de la variable que contiene el token del nuevo registro agregado.

Solicitud

Ejemplo de solicitud

curl --request PUT 'https://api.upnify.com/v4/clientes/00000000-0000-4000-8000-000000000010/archivar' \
  --header 'token: 00000000-0000-4000-8000-000000000001' \
  --header 'Content-Type: application/json' \
  --data-raw '{"tipo":1}'

Respuesta

Ejemplo de respuesta

JSON
{
  "code": 0,
  "msg": "Ok",
  "details": "detalle-ejemplo"
}