Crear Lead

Crear Lead #

Crea un nuevo lead o prospecto en el ecosistema.

URL del endpoint #

POST /create-lead

Parámetros de entrada #

Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON. A continuación, se detallan los parámetros requeridos:

Parámetro Tipo Descripción
name str Nombre del lead.
lastname str Apellido del lead.
nit str NIT o número de identificación del lead.
phone str Número de teléfono del lead.
email str Dirección de correo electrónico del lead.
address str Dirección del lead.
ecosystem str ID del ecosistema del lead.
business_entity str Entidad empresarial del lead.
business_name str (opcional): Nombre de la empresa del lead.
quota str (opcional): Cupo del lead.
lead_status str (opcional): Estado del lead.
records list (opcional): Lista de registros asociados al lead.
history list (opcional): Historial del lead.
score int (opcional): Puntaje del lead.
created_at str (opcional): Fecha de creación del lead.
loan_priority str (opcional): Prioridad del préstamo del lead.
image str (opcional): URL de la imagen asociada al lead.
additional_data dict (opcional): Datos adicionales del lead.

Encabezados #

Encabezado Valor
Authorization Bearer {token}
Content-Type application/json

Respuesta esperada #

El método devuelve una respuesta en formato JSON con los siguientes campos:

  • En caso de éxito, la respuesta tendrá el código de estado 200 y contendrá los siguientes datos:
{
  "id": "string",
  "image": "string",
  "name": "string",
  "lastname": "string",
  "business_name": "string",
  "quota": 0,
  "status": "string",
  "phone": "string",
  "email": "string",
  "nit": "string",
  "address": "string",
  "history": [],
  "score": 0.0,
  "payment_data": {},
  "apn_token": "string",
  "ecosystem": "string",
  "business_entity": "string",
  "additional_data": {}
}

Ejemplos de uso #

Python # 

import requests
import json

url = "https://api.leancore.co/create-lead"

# Cabecera de autorización con Bearer token
headers = {
    "Authorization": "Bearer <token>"
}

# Datos del lead a crear
lead_data = {
    "name": "John",
    "lastname": "Doe",
    "business_name": "ABC Company",
    "quota": 5000,
    "lead_status": "new",
    "phone": "1234567890",
    "email": "john@example.com",
    "nit": "123456789",
    "address": "123 Street, City",
    "ecosystem": "ecosystem_id",
    "business_entity": "business_entity_id",
    "additional_data": {
        "variables_data": [
            {
                "key": "variable1",
                "value": "value1"
            },
            {
                "key": "variable2",
                "value": "value2"
            }
        ]
    }
}

# Realizar la solicitud POST para crear el lead
response = requests.post(url, headers=headers, json=lead_data)

# Obtener la respuesta
if response.status_code == 200:
    lead = response.json()
    print("Lead creado exitosamente:")
    print(lead)
else:
    print("Error al crear el lead. Código de respuesta:", response.status_code)
    print("Mensaje de error:", response.text)