Cadastrar lead

🔒

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)

Cadastra um novo lead com dados cadastrais mínimos. A obrigatoriedade de
email/telefone segue a configuração Campos obrigatórios no cadastro de
leads
(obrigatorio_cadastro_leads, em
/gestor/configuracoes/configuracoesespecifico/leads): por padrão, exige ao
menos um dos dois, mas pode ser configurada para exigir e-mail, telefone, ou
ambos; o não atendimento à regra configurada retorna 400.
Dois leads não podem compartilhar o mesmo email, o mesmo telefone nem o
mesmo codigoInterno — a duplicidade retorna 400. telefone e
telefoneAlternativo já devem vir com o DDI incluso (ex.: +5579998877665);
quando o DDI é omitido, assume-se +55. nome assume
"Sem nome" quando omitido. idMidia precisa existir na base — se o ID
informado não existir, o campo é ignorado (não cria uma mídia nova).
origem ausente ou inválida é derivada do painel autenticado
(gestor → GE, imobiliaria → IM, corretor → CO, pdv → PV);
caso contrário, ND.

idTag, idEmpreendimento e idProduto associam o lead a registros
já existentes (apenas IDs — este endpoint não cria tag/produto por
nome). A validação é estrita: se qualquer ID informado não existir
(ou, no caso de empreendimento/produto, não estiver ativo), a
requisição inteira é rejeitada com 400 e nada é persistido —
diferente do comportamento tolerante de /leads/{idLead}/interesses.
Associar idProduto pode cascatear automaticamente o(s)
empreendimento(s) ao qual o produto está vinculado (mesmo
comportamento herdado de /interesses). Não existe campo de região
no cadastro do lead: ela é sempre calculada a partir do(s)
empreendimento(s) associados (ver GET /leads/{idLead}).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Dados cadastrais do lead a ser criado.

A obrigatoriedade de email/telefone segue a configuração "Campos obrigatórios no cadastro de leads" (obrigatorio_cadastro_leads, em /gestor/configuracoes/configuracoesespecifico/leads): por padrão, exige ao menos um dos dois; pode ser configurada para exigir e-mail, telefone, ou ambos. O não atendimento à regra configurada retorna 400. Essa regra de negócio não é expressável como required do JSON Schema (depende de configuração e é uma condição "ou"/"e"), por isso é documentada aqui em texto.

string

Nome do lead (assume "Sem nome" se omitido)

string

Identificador do cliente nas plataformas da Meta, recebido nas conversas de WhatsApp. Aceito como alternativa ao telefone na identidade mínima. Não podem existir dois leads ativos com o mesmo identificador (salvo se a configuração permitir leads duplicados).

string

E-mail do lead (obrigatoriedade conforme obrigatorio_cadastro_leads)

string

Telefone do lead (obrigatoriedade conforme obrigatorio_cadastro_leads). O DDI pode vir embutido ou ser informado em telefoneDdi; quando omitido em ambos, assume-se "+55". Números +55 são validados (DDD válido + formato); demais DDIs são aceitos como enviados.

string

DDI do telefone; deve iniciar com "+" (ex.: "+55", "+1"). Omitido, assume-se "+55".

string

Telefone alternativo. O DDI pode vir embutido ou ser informado em telefoneAlternativoDdi; quando omitido em ambos, assume-se "+55".

string

DDI do telefone alternativo; deve iniciar com "+". Omitido, assume-se "+55".

string

E-mail alternativo do lead

string
enum

Tipo de documento

Allowed:
string

Número do documento

string
enum

Sexo do lead

Allowed:
string

Renda familiar (string monetária)

string

CEP do endereço

string

Logradouro do endereço

string

Número do endereço

string

Complemento do endereço

string

Bairro do endereço

integer

ID do estado do endereço

integer

ID da cidade do endereço

string

URL/identificador do Facebook do lead

string

URL/identificador do Instagram do lead

string

URL/identificador do Twitter/X do lead

string

Origem do lead (conforme tabela de referência). Ausente/inválida é derivada do painel autenticado (gestor->GE, imobiliaria->IM, corretor->CO, pdv->PV); caso contrário "ND"

string

Painel de origem da chamada (gestor, imobiliaria, corretor)

integer

ID da mídia de origem. Precisa existir na base — se o ID informado não existir, o campo é ignorado (não cria uma mídia nova)

integer

Código interno único usado pela construtora

boolean

Quando true, ignora a validação de unicidade de e-mail

boolean

Quando true, ignora a validação de unicidade de código interno

boolean

Quando true, mantém o documento como enviado (não remove caracteres não alfanuméricos)

idTag
array of integers

IDs de tags já existentes para associar ao lead. Apenas IDs (não cria tag por nome) — ID inexistente rejeita a requisição inteira.

idTag
idEmpreendimento
array of integers

IDs de empreendimentos já existentes e ativos para associar ao lead. ID inexistente/inativo rejeita a requisição inteira.

idEmpreendimento
idProduto
array of integers

IDs de produtos já existentes e ativos para associar ao lead. Pode cascatear a associação do(s) empreendimento(s) vinculado(s) ao produto. ID inexistente/inativo rejeita a requisição inteira.

idProduto
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json