Registrar conversão do lead

post

https://{dominiodocliente}.cvcrm.com.br/api/v4/comercial/leads/{idLead}/conversoes

🔒
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 na introdução
(ú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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

idLead

int64

required

Identificador do lead.

Body Params

conversao

string

required

length ≤ 100

Nome da conversão (ex.: nome da landing page ou campanha). Criado no cadastro de conversões se ainda não existir.

origem

string

length between 2 and 2

Código de origem da conversão cadastrado no CV. Omitido usa o painel autenticado; não cadastrado vira ND.

integracao

string

enum

Integração de marketing de onde veio a conversão: RD RD Station, SS SharpSpring, FB Facebook.

Allowed:

idIntegracao

string

length ≤ 100

Identificador do lead na base da integração. Aceita texto ou número e é gravado como texto. Tamanho máximo: 45 caracteres com FB, 80 com RD, 100 com SS ou sem integração; acima disso retorna 400.

idFormulario

int64

Identificador do formulário do Facebook cadastrado no CV (o mesmo idformulario da integração Facebook do CV, não o id do formulário na Meta). Só é aceito com integracao = FB; caso contrário retorna 422.

idMidia

int64

Identificador da mídia da conversão.

idEmpreendimentos

array of int64s

Empreendimentos de interesse associados à conversão.

idEmpreendimentos

dataCadConversao

string

^\d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?$

Data da conversão em ISO, YYYY-MM-DD ou YYYY-MM-DD HH:MM:SS. Só a data grava 00:00:00; omitida usa a data e hora do registro.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Conversão registrada. idConversao é o identificador do registro no histórico de conversões do lead.

400Corpo inválido: conversao ausente ou vazio após a normalização, idMidia não inteiro, idFormulario não inteiro, idIntegracao acima do tamanho máximo da integração, idEmpreendimentos que não é lista de inteiros, ou campos de texto com tipo incorreto.

401Token ausente, inválido ou expirado, ou painel não autorizado para esta rota.

403O perfil do usuário não tem a permissão comercial|leads|2.

404Lead inexistente, inativo ou fora do escopo do painel autenticado (Corretor e Imobiliária só acessam os leads que atendem).

409A mesma conversão (nome, mídia e origem) já foi registrada para o lead há menos de 5 minutos. Nada foi gravado.

422Requisição bem formada, recusada por regra de negócio: dataCadConversao fora do padrão ISO ou com data inexistente, integracao fora de RD/SS/FB, ou idFormulario enviado sem integracao = FB.

429Limite de requisições da API excedido. Repita a chamada depois.

500Falha inesperada ao registrar a conversão. Nada é gravado (a operação é transacional).