🔒

Autenticação necessária

Esta API utiliza Bearer Token no header Authorization.
Consulte o tutorial completo antes de fazer sua primeira chamada:
Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Registra uma conversão para o lead e aplica os efeitos descritos abaixo em "Efeitos no lead"
(última conversão, bolsão, integração, fila, notificação e RD Station).

Disponível para os painéis Gestor, Imobiliária e Corretor. Exige a permissão
comercial|leads|2 no perfil do usuário.

Registro e consulta das conversões de um lead. Uma conversão é cada entrada do lead
por um formulário, landing page ou integração de marketing (RD Station, SharpSpring,
Facebook).

Nome da conversão

conversao é obrigatório. O nome é normalizado (tags HTML removidas, espaços nas pontas
cortados) e limitado a 100 caracteres. Se não existir no cadastro de conversões, uma
conversão nova é criada com esse nome. Nomes digitados de forma diferente geram
conversões diferentes.

Origem da conversão

origem é a origem da conversão, não do lead, e deve ser um dos códigos de origem
cadastrados no CV (2 caracteres, ex.: GE, IM, CO, FB). Regras:

• informada e cadastrada: é usada;
• informada e não cadastrada: vira ND;
• omitida: é derivada do painel autenticado (Gestor → GE, Imobiliária → IM,
  Corretor → CO).

Conversão duplicada

A mesma conversão (mesmo nome, mesma mídia e mesma origem) registrada para o mesmo lead
em até 5 minutos da última é recusada com 409, sem nenhum efeito no lead.

Efeitos no lead

Registrar uma conversão tem os mesmos efeitos do cadastro de conversão da v1:

• atualiza a última conversão, a última origem e a data da última conversão do lead;
• na primeira conversão do lead, grava também a conversão original;
• retira o lead do bolsão;
• atualiza o identificador do lead na integração informada (RD Station e SharpSpring no
  próprio lead; Facebook no vínculo lead × formulário);
• com a configuração "Fila a cada nova conversão" ligada, redistribui o lead pela fila,
  respeitando "a cada quantas conversões";
• notifica o corretor e o gestor que atendiam o lead;
• envia o evento de conversão ao RD Station quando a integração está configurada para
  envio e integracao não é RD.

Mudanças em relação à v1

• O registro de conversão sai do endpoint monolítico POST /api/v1/comercial/leads
  para o sub-recurso dedicado /api/v4/comercial/leads/{idLead}/conversoes, que também
  oferece listagem paginada, com filtros e ordenação.
• dataCadConversao passa do formato brasileiro (dd/mm/aaaa) para ISO
  (YYYY-MM-DD ou YYYY-MM-DD HH:MM:SS). Data fora do padrão retorna 422, em vez de
  ser trocada silenciosamente pela data atual.
• origem passa a representar só a origem da conversão, desacoplada da origem do lead.
• integracao, idIntegracao e idFormulario passam a ficar gravados na própria
  conversão e voltam na listagem. Conversões anteriores aparecem com esses campos nulos.
• Conversão duplicada em até 5 minutos: descartada sem aviso na v1, 409 na v4.
• idFormulario sem integracao = FB: ignorado na v1, 422 na v4.