Interesses do Lead

Adicionar interesses do 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)

Adiciona empreendimento(s), unidade(s) e/ou produto(s) de interesse ao lead, e opcionalmente atualiza o motivo de escolha. Sempre aditivo: nunca remove interesses já associados — para substituir o conjunto, use PATCH. Todos os campos são opcionais, mas ao menos um precisa ser enviado.

  • idEmpreendimento: associa apenas os empreendimentos ativos e visíveis ao painel autenticado; os demais são reportados em naoAssociados.
  • idUnidade: associa apenas unidades ativas e visíveis ao painel (unidade, bloco e etapa precisam estar todos ativos/visíveis); o empreendimento da unidade também é associado automaticamente como interesse.
  • idProduto/produto: duas formas independentes de referenciar produtos — envie apenas a que fizer sentido para o seu caso (não é necessário enviar as duas). idProduto aceita IDs de produtos já existentes e ativos; produto aceita nomes e cria o produto automaticamente quando o nome ainda não existe. Se as duas forem enviadas na mesma requisição, devem se referir a produtos diferentes — cada uma é resolvida de forma independente. Produtos vinculados a empreendimentos também associam esses empreendimentos automaticamente.
  • idMotivoEscolha: precisa existir e estar ativo, senão é reportado em naoAssociados sem bloquear os demais campos do mesmo request.

Se nenhum item do payload puder ser associado/atualizado, a resposta é 422. Se ao menos um item for processado com sucesso, a resposta é 201 e os itens rejeitados aparecem em data.naoAssociados (chave presente apenas quando há rejeição parcial).

post/leads/{idLead}/interesses

Request

  • Base URL
    https://integracao.cvcrm.com.br/api/v4/comercial
  • URL
    https://integracao.cvcrm.com.br/api/v4/comercial/leads/{idLead}/interesses
  • Auth
    HTTP bearer

Path parameters

idLeadinteger required
Example:48213

ID do lead

Request body

idEmpreendimentointeger[]

IDs de empreendimentos de interesse. No POST, somam-se aos já associados; no PATCH, substituem o conjunto atual.

idUnidadeinteger[]

IDs de unidades de interesse. O empreendimento de cada unidade também é associado automaticamente.

idProdutointeger[]

IDs de produtos já existentes e ativos.

produtostring[]

Nomes de produtos de interesse. Cria o produto automaticamente quando o nome ainda não existe.

idMotivoEscolhainteger

ID do motivo de escolha do empreendimento. Precisa existir e estar ativo.

Example request

{
  "idEmpreendimento": [
    15,
    22
  ],
  "idUnidade": [
    3401
  ],
  "idProduto": [
    7
  ],
  "produto": [
    "Cobertura Duplex"
  ],
  "idMotivoEscolha": 4
}

Response

Interesse(s) adicionado(s) com sucesso ao lead.

statusstring required
codeinteger required

Example response

{
  "status": "success",
  "code": 201,
  "data": {
    "idLead": 48213,
    "naoAssociados": {
      "idEmpreendimento": [
        99
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.