Leads

Atualizar Lead

Atualiza os dados de um lead específico.

PUT/lead/{id}

curl --request PUT \
  --url 'https://crm.wavups.com/api/v1/lead/clxyz1234' \
  --header 'Token: SEU_TOKEN_DE_API' \
  --header 'Content-Type: application/json' \
  --data '{
    "leadTemperature": 3,
    "status": "Qualificado",
    "phone": "5511987654321",
    "city": "Lisboa",
    "country": "Portugal",
    "customFields": {
      "plano": "Ouro",
      "cliente_vip": true,
      "observacao_interna": null
    },
    "utms": {
      "utm_source": "fb",
      "utm_medium": "paid",
      "utm_campaign": "120243645529690704",
      "utm_term": "120243645529720704",
      "utm_content": "120247590343130704"
    }
  }'

{
  "message": "Lead updated"
}

Requisição

Tokenstringobrigatório

Seu token de autenticação.

Path Parameters

idstringobrigatório

ID do lead a ser atualizado.

Body

Envie os campos que deseja atualizar. Todos os campos são opcionais:

namestring

Nome do lead.

emailstring

E-mail do lead.

phonestring

Telefone do lead.

O número deve estar no formato 5547999999999 (código do país + DDD + número, sem espaços, traços ou parênteses). Qualquer outro formato causará erros nos disparos via WhatsApp.

taxIdstring

CPF/CNPJ do lead.

sourcestring

Origem do lead.

leadOwnerstring

ID do usuário responsável pelo lead.

profileImagestring

URL da imagem de perfil do lead.

zipCodestring

CEP do endereço.

statestring

Estado.

citystring

Cidade.

neighborhoodstring

Bairro.

streetAddressstring

Logradouro.

numberstring

Número do endereço.

complementstring

Complemento do endereço.

countrystring

País do lead, em português (ex: Brasil, Portugal, Estados Unidos). Um nome da lista de países da plataforma é gravado com a grafia dela, sem diferenciar maiúsculas e acentos (brasil vira Brasil); outro texto é gravado como veio.

descriptionstring

Descrição ou observações.

leadTypestring

Tipo do lead (ex: PF, PJ).

leadTemperaturenumber

Temperatura do lead, em número inteiro. Um valor que não seja inteiro devolve 400.

metadataobject

Metadados adicionais do lead em formato JSON.

customFieldsobject

Campos personalizados do lead, pela chave do campo (veja a chave em Leads > Campos, na plataforma). Exemplo: { "plano": "Ouro", "limite_de_credito": "1.500,50" }.

Seleção: o nome ou o id da opção. Seleção múltipla: uma lista de nomes.
Número e moeda: 1500 ou 1.500,50. Data: 2026-03-15 ou 15/03/2026. Sim/Não: true/false ou sim/não.
Chave desconhecida ou valor inválido responde 400 e nada é gravado.
Campos obrigatórios da conta não são exigidos por esta API.
Neste endpoint, null ou texto vazio limpa o campo, e os campos que você não enviar ficam como estão.

utmsobject

Parâmetros UTM associados ao lead em formato JSON. O objeto enviado deve conter as seguintes propriedades:

utm_source (string): Origem do tráfego (ex: fb, google, instagram).
utm_medium (string): Meio do tráfego (ex: paid, cpc, organic, story).
utm_campaign (string): Identificador ou nome da campanha (ex: 120243645529690704).
utm_term (string): Termo de pesquisa ou identificador de público/anúncio (ex: 120243645529720704).
utm_content (string): Conteúdo do anúncio ou identificador do criativo (ex: 120247590343130704).

Exemplo:

json

{
  "utm_source": "fb",
  "utm_medium": "paid",
  "utm_campaign": "120243645529690704",
  "utm_term": "120243645529720704",
  "utm_content": "120247590343130704"
}

statusstring

Status do lead.

Resposta

Retorna uma mensagem de sucesso confirmando a atualização.

messagestring

Confirma que o lead foi atualizado com sucesso.

Autorização

Tokenstring · headerobrigatório

Token de autenticacao gerado na plataforma WavUps CRM.

Parâmetros de caminho

idstringobrigatório

Identificador único do recurso.

Corpo da requisição

application/json · object

namestring

emailstring

phonestring

Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos ou simbolos).

Exemplo: "5547999999999"

taxIdstring

CPF ou CNPJ do lead.

Exemplo: "12345678909"

sourcestring

leadOwnerstring

profileImagestring

zipCodestring

statestring

citystring

neighborhoodstring

streetAddressstring

numberstring

complementstring

countrystring

Pais do lead, em portugues. Um nome da lista de paises da plataforma e gravado com a grafia dela.

Exemplo: "Brasil"

descriptionstring

leadTypestring

leadTemperatureenum<integer>

Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).

Valores aceitos: 1, 2, 3

statusstring

metadataobject | null

Metadados adicionais do lead em formato JSON.

customFieldsobject

Campos personalizados do lead, pela chave do campo (a chave aparece em Leads > Campos, na plataforma). Seleção aceita o nome ou o id da opção; números aceitam `1500` ou `1.500,50`; datas, `2026-03-15` ou `15/03/2026`; Sim/Não, `true`/`false` ou `sim`/`não`. Chave desconhecida ou valor inválido responde `400` e nada é gravado. Na atualização, `null` ou texto vazio limpa o campo e os campos que não forem enviados ficam como estão.

Exemplo:

{
  "plano": "Ouro",
  "limite_de_credito": "1.500,50"
}

utmsobject | null

Parâmetros UTM associados ao lead em formato JSON.

Respostas

200application/json · object

Lead atualizado com sucesso.

messagestring

Exemplo: "Operação realizada com sucesso."

404

500