Atualizar lead

patch

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

🔒
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)

Atualiza parcialmente os dados cadastrais de um lead: apenas os campos
enviados no corpo são alterados, os demais permanecem inalterados. O
nome pode ser alterado livremente. Se email, telefone ou
codigoInterno forem enviados, a unicidade é revalidada (ignorando o
próprio lead).

idTag, idEmpreendimento e idProduto seguem a mesma validação
estrita do POST (apenas IDs já existentes; qualquer ID inválido
rejeita a requisição inteira, nada é alterado) e são sempre
aditivos: associações já existentes nunca são desassociadas por
esta rota, mesmo substituindo o conjunto anterior — use
/leads/{idLead}/interesses ou DELETE /lead-tags para remover.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

idLead

integer

required

ID do lead

Body Params

Campos cadastrais a atualizar (todos opcionais).

Todos os campos são opcionais — apenas os enviados são alterados.

nome

string

identificador_meta

string

Identificador do cliente nas plataformas da Meta, recebido nas conversas de WhatsApp. Não podem existir dois leads ativos com o mesmo identificador (salvo se a configuração permitir leads duplicados).

string

telefone

string

Telefone do lead. 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.

telefoneDdi

string

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

telefoneAlternativo

string

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

telefoneAlternativoDdi

string

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

emailAlternativo

string

documentoTipo

string

enum

Allowed:

documento

string

sexo

string

enum

Allowed:

rendaFamiliar

string

cep

string

endereco

string

numero

string

complemento

string

bairro

string

idEstado

integer

idCidade

integer

facebook

string

instagram

string

twitter

string

origem

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"

idMidia

integer

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

codigoInterno

integer

ignorarEmail

boolean

ignorarCodigoInterno

boolean

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

pessoaEstrangeira

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 (aditivo — nunca desassocia tags já existentes). Apenas IDs — ID inexistente rejeita a requisição inteira.

idTag

idEmpreendimento

array of integers

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

idEmpreendimento

idProduto

array of integers

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

idProduto

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

200Lead atualizado com sucesso.

400Dados inválidos: e-mail/telefone/código interno já usado por outro lead, campo com formato inválido (ex.: e-mail mal formatado, documentoTipo fora de cpf/cnpj, sexo fora de M/F), ou idTag/idEmpreendimento/idProduto com algum ID inexistente/inativo (nesse caso, nada é alterado).

401Token inválido ou não informado.

403Usuário autenticado sem permissão para editar leads.

404Lead inexistente.

429Limite de requisições excedido (rate limit).

500Erro interno do servidor.