erp | Centro de Ayuda

API Endpoint: CRM

Listar Leads

• URL: /crm.list.json
• Método: GET
• Descripción: Obtiene una lista de leads de CRM según varios filtros aplicados.
• Parámetros (opcional):
  • id: Filtra por el ID.
  • id_desde: Filtra a partir de un id >=.
  • titulo: Filtra por título del lead (LIKE).
  • nombre_empresa: Filtra por nombre de la empresa asociada al lead (LIKE).
  • contacto: Filtra por nombre del contacto (LIKE).
  • telefono: Filtra por número de teléfono del lead (LIKE).
  • celular: Filtra por número de celular del lead (LIKE).
  • email: Filtra por correo electrónico del lead (LIKE).
  • importe: Filtra por importe asociado al lead (LIKE).
  • f_desde_ultimaaccion: Fecha desde para filtrar por última acción realizada (formato dd-mm-aaaa).
  • f_hasta_ultimaaccion: Fecha hasta para filtrar por última acción realizada (formato dd-mm-aaaa).
  • f_desde_registro: Fecha desde para filtrar por fecha de registro (formato dd-mm-aaaa).
  • f_hasta_registro: Fecha hasta para filtrar por fecha de registro (formato dd-mm-aaaa).
  • fecha_proximaaccion: Filtra por la fecha de la próxima acción planificada.
  • accion_tarea: Filtra por el tipo de acción/tarea de la próxima acción.
  • responsable: Filtra por el usuario responsable del lead.
  • estado: Filtra por el estado actual del lead. 
    
    

    0 = Abierto

    1 = Ganado

    2 = Perdido

    3 = Cancelado

    4 = Contactado
  • etapa: Filtra por la etapa del proceso en la que se encuentra el lead.
     

    0 = Pendiente

    1 = Por contactar

    2 = Propuesta enviada

    3 = Negociacion
  • campana: Filtra por la campaña asociada al lead. ( Se puede obtener desde crm.listCampanas.json)
  • cl_esProspecto: Filtra por si el lead es prospecto (0 para no prospecto).
  Nota: Todos estos parámetros se combinan para formar las condiciones en la consulta, por lo que se aplicarán solo aquellos que no estén vacíos.
• ORDER BY (cl_id) Campo por el cual permite ordenar ASC, DESC.

Crear Lead

• URL: /crm.create.json
• Método: POST
• Descripción: Crea un nuevo lead en el CRM con los datos proporcionados.
• Body (JSON):
  • titulo: Título del lead.
  • empresa: Nombre de la empresa asociada al lead.
  • contacto: Nombre del contacto.
  • contacto_cargo: Cargo del contacto.
  • telefono: Número de teléfono del lead.
  • celular: Número de celular del lead.
  • email: Correo electrónico del lead.
  • sitioweb: Sitio web de la empresa.
  • ciudad: Ciudad del lead.
  • pais: País del lead.
  • medio_contacto: Medio de contacto preferido.
  • mensaje: Mensaje asociado al lead.
  • importe: Importe asociado al lead.
  • importe_moneda: Moneda del importe.
  • probabilidad: Probabilidad de éxito del lead (porcentaje).
  • responsable: Usuario responsable del lead.
  • estado: Estado actual del lead.
  • etapa: Etapa del proceso en la que se encuentra el lead.
  • origen: Origen del lead.
  • origen_id_referencia: ID de referencia del origen.
  • campana_id: ID de la campaña asociada.
  • cliente_id: ID del cliente asociado.
  Nota: La fecha de registro se establece automáticamente en la fecha actual del sistema.

Ejemplo JSON : 

{
"titulo" : "probandoooo",
"empresa" : "",
"contacto" : "",
"telefono" : "",
"celular" : "",
"email" : "",
"sitioweb" : "",
"ciudad" : "",

"importe" : "",
"probabilidad" : "",
"responsable" : "",

"estado" : "",
"etapa" : "",
"origen" : "",
"cliente_id" : ""

}

Actualizar Lead

• URL: /crm.update.json
• Método: POST
• Descripción: Actualiza un lead existente en el CRM con los nuevos datos proporcionados.
• Body (JSON):
  • (Se utiliza la misma estructura que en el método de creación, pero con los campos actualizar)
  • Se debe enviar cl_id = {$id_lead} (id del lead a actualizar)

{
"titulo" : "probandoooo",
"cl_id" : ""

}