Crear o actualizar leads

curl --request POST \
  --url https://api.getnexor.ai/api/public/leads \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "phone": "+1234567890",
  "workflow_id": "uuid-of-workflow",
  "campaign_id": "uuid-of-campaign"
}
'

{
  "success": true,
  "lead": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "source": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "company": "<string>",
    "title": "<string>",
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assigned_user": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  },
  "existed": true,
  "workflow_run": "<unknown>",
  "workflow_run_skipped": "<unknown>",
  "moved_from": "<unknown>",
  "force_first_message": "<unknown>",
  "force_first_channel": "<unknown>",
  "sms_consent": "<unknown>",
  "whatsapp_consent": "<unknown>",
  "warning": "<unknown>"
}

POST

leads

curl --request POST \
  --url https://api.getnexor.ai/api/public/leads \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "phone": "+1234567890",
  "workflow_id": "uuid-of-workflow",
  "campaign_id": "uuid-of-campaign"
}
'

{
  "success": true,
  "lead": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "source": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "company": "<string>",
    "title": "<string>",
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assigned_user": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  },
  "existed": true,
  "workflow_run": "<unknown>",
  "workflow_run_skipped": "<unknown>",
  "moved_from": "<unknown>",
  "force_first_message": "<unknown>",
  "force_first_channel": "<unknown>",
  "sms_consent": "<unknown>",
  "whatsapp_consent": "<unknown>",
  "warning": "<unknown>"
}

Si workflow_id apunta a una tarea activa, Nexor empieza a contactar al lead de inmediato. Normalmente ocurre según su cadencia (WhatsApp, llamadas y otros canales); las llamadas esperan el horario de contacto de la tarea, y los mensajes salen de inmediato salvo que la tarea los restrinja a su horario; con force_first_message, tu primer mensaje sale de inmediato sin importar el horario. No se contacta a los leads marcados como no contactar, y las tareas que solo responden (solo entrantes) no inician contacto. Si la tarea está en pausa, el contacto empieza cuando la actives.

Mapeo automático de metadataCualquier clave en el cuerpo de la solicitud que no sea una columna principal del lead (first_name, last_name, email, phone, source, company, title, city, date_of_birth, external_id, assigned_to, workflow_id, campaign_id, tags, force_first_message, force_first_channel, skip_first_message) será automáticamente mapeada al objeto metadata. Esto significa que puedes pasar campos extra al nivel superior sin envolverlos explícitamente en metadata.Por ejemplo, enviar { "first_name": "Tony", "edad": 35, "broker": "Tony" } es equivalente a { "first_name": "Tony", "metadata": { "edad": 35, "broker": "Tony" } }.Si proporcionas tanto claves extra de nivel superior como un objeto metadata, se fusionarán, con los valores explícitos de metadata teniendo precedencia.

Importar leads que ya tienen un responsableEnvía assigned_to con el ID del miembro del equipo — lo obtienes desde GET /team: el campo id de cada miembro es el valor que debes usar. El responsable debe ser un miembro activo de tu cuenta; cualquier otro valor se rechaza con 400.Asignar un responsable es independiente de workflow_id: workflow_id define qué agente de IA trabaja el lead, assigned_to registra qué persona es dueña de él.

Autorizaciones

X-API-Key

string

header

requerido

API key for authentication. Keys are prefixed with nxr_live_.

Cuerpo

application/json

object
object[]

first_name

string

requerido

Lead's first name

Ejemplo:

"John"

last_name

string

Lead's last name

Ejemplo:

"Doe"

string<email>

Lead's email address

Ejemplo:

"john@example.com"

phone

string

Lead's phone number (required if assigning to a workflow with call steps)

Ejemplo:

"+1234567890"

metadata

object

Arbitrary key-value data specific to your organization. Use this to store any custom information about the lead (e.g., age, salary range, assigned broker, lead status, notes). There is no enforced schema — send any keys and values you need. Values can be strings, numbers, or booleans.

Ejemplo:

{
  "edad": 35,
  "rango_sueldo": "$2000-$4000",
  "broker_asociado": "Juan Perez",
  "estado_lead": "interesado",
  "notas_asociadas": "Prefiere contacto por WhatsApp"
}

workflow_id

string<uuid>

Workflow ID to assign the lead to. Use GET /workflows to list available workflows.

Ejemplo:

"123e4567-e89b-12d3-a456-426614174000"

campaign_id

string<uuid>

Campaign ID to tag the lead with (optional). Use GET /campaigns to list available campaigns.

Ejemplo:

"123e4567-e89b-12d3-a456-426614174001"

force_first_message

object

Override the first outreach with a custom message. Requires workflow_id. The rest of the cadence sequence continues normally from the second touchpoint.

Show child attributes

assigned_to

string<uuid> | null

ID of the team member who owns this lead. Must be an active member of your account — use GET /team to list them and copy the id field. Rejected with 400 otherwise.

Ejemplo:

"123e4567-e89b-12d3-a456-426614174002"

source

string

predeterminado:api

company

string | null

title

string | null

city

string | null

date_of_birth

string<date> | null

external_id

string | null

Respuesta

An existing identity was matched and merged.

success

enum<boolean>

requerido

Opciones disponibles:

true

lead

object

requerido

Show child attributes

existed

boolean

workflow_run

any