Recebimento de leads na fila, leitura do fluxo comercial e ações nomeadas (anotar, descartar, visita, proposta).
Sobre esta seçãoÉ por aqui que interessados entram no CRM. Sempre que um portal, o site da imobiliária ou uma landing page captura um lead, esta seção entrega esse contato direto na fila de atendimento do convênio, que o distribui para um corretor. Lead de proprietário (captação) entra pela mesma rota, com
fluxo: "captacao".Depois, o fluxo pode ser lido (atendimento, captação, visita, proposta, negócio) e movido por ações nomeadas: anotar, descartar, etiquetar, agendar e conduzir visita, criar proposta. Nunca edição livre: cada ação tem rota própria e recusa com código estável quando não pode ser feita.
Escopos:
leads:writepara receber lead;<objeto>:readpara ler;atendimentos:write,visitas:writeepropostas:writepara as ações.
Pontos que valem para toda a seção:
| Regra | O que significa |
|---|---|
| 📡 Mídia vem da chave | A origem não vem do corpo. Cada chave representa uma origem; portal, midia e origem no corpo são ignorados de propósito. |
| 🔤 Campos flexíveis | Os nomes casam com o vocabulário de cada portal: name/nome, phone/telefone/celular, message/mensagem. O imóvel de interesse vai em imovel (ou codigoImovel). |
| 🔎 Leitura e busca | Atendimento, captação, visita, proposta e negócio têm GET /{id} e POST /search, cada um com o próprio escopo :read. Cada item da busca vem no formato do GET /{id}. |
| 🧭 Ação, não edição | Anotar, descartar, etiquetar, agendar, reagendar, mudar situação, dar parecer e incluir proposta são ações com rota própria. Cada recusa volta com um código estável e cada ação dispara o webhook do evento. Não há parâmetro para pular regra. |
| 🏷️ Motivo por nome | Motivo de descarte, de cancelamento de visita e de parecer vão pelo nome que GET /schema/support devolve. |
| 🔁 Reenvio é seguro | A rota é idempotente por external_id: reenvie após um 429 ou falha de rede sem duplicar o lead. |