orkasa

Recursos

Leads

listar · ver · crear · actualizar · archivar

Un lead es la persona. Lo que se trabaja cuelga de su operación.

Filtros

GET /leads?temperature=&origin=&email=&assigned_agent_id=&include_archived=

email empareja sin distinguir mayúsculas, porque una dirección escrita por una persona no viene fiablemente en minúsculas. Ese filtro es lo que hace funcionar la búsqueda Find Lead de Zapier como mitad de un buscar-o-crear.

Crear

POST /leads corre la misma primitiva que la aplicación: busca o crea el contacto (emparejando por teléfono y correo normalizados), inserta el lead, asigna un agente por turno rotativo, abre la operación del lead y lanza la revisión de sanciones. El id de la operación nueva vuelve como operation_id.

full_namestringrequired
phonestring
emailstring
originstring

Incluye email, el valor para los leads que reenvía una automatización de buzón. Así el embudo los atribuye en vez de enterrarlos en other.

operation_typebuy | rent

Opcional. Si lo das, se abre la operación exactamente como en la aplicación. Si lo omites, el lead y su contacto se crean sin operación y operation_id vuelve null: un lead en crudo, por calificar.

budget_maxnumber
bedrooms_minnumber
intentstring
notesstring
email_subjectstring

El asunto del correo reenviado. No se guarda en el lead.

email_bodystring

El cuerpo del correo. Mándalo y el lead lo califica la IA, igual que un mensaje entrante de WhatsApp. Si falta, un lead con origin: "email" cae en notes — así un Zap antiguo que mapea el cuerpo a notes sigue calificando sin reconfigurarse.

operation_type: "sell" se rechaza con 422. Una captación se negocia con un propietario y termina en un mandato firmado; no empieza en este endpoint, y meterla a la fuerza en una operación de demanda sería peor que negarla.

Ejemplo completo en De lead a visita.

Archivar

DELETE /leads/{id} es un archivado suave (archived_at + archive_reason), nunca un borrado. Un lead es la raíz de contactos, operaciones, visitas y ofertas: borrarlo de verdad dejaría huérfano todo lo demás.

Los leads de captación —los vendedores— llevan lead_status en NULL. Un filtro escrito como « distinto de archivado » los descarta en silencio. Si quieres contar la oferta, filtra por operation_type, no por estado.