# Atualizar Lead

> Atualiza os dados de um lead específico.

`PUT https://crm.wavups.com/api/v1/lead/{id}`

Página: https://crm.wavups.com/docs/api/leads/atualizar

## Requisição

- `Token` (string, obrigatório, header):
  Seu token de autenticação.

### Path Parameters

- `id` (string, obrigatório, path):
  ID do lead a ser atualizado.

### Body

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

- `name` (string, body):
  Nome do lead.

- `email` (string, body):
  E-mail do lead.

- `phone` (string, body):
  Telefone do lead.

  **Atenção:**
  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.
  

- `taxId` (string, body):
  CPF/CNPJ do lead.

- `source` (string, body):
  Origem do lead.

- `leadOwner` (string, body):
  ID do usuário responsável pelo lead.

- `profileImage` (string, body):
  URL da imagem de perfil do lead.

- `zipCode` (string, body):
  CEP do endereço.

- `state` (string, body):
  Estado.

- `city` (string, body):
  Cidade.

- `neighborhood` (string, body):
  Bairro.

- `streetAddress` (string, body):
  Logradouro.

- `number` (string, body):
  Número do endereço.

- `complement` (string, body):
  Complemento do endereço.

- `country` (string, body):
  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.

- `description` (string, body):
  Descrição ou observações.

- `leadType` (string, body):
  Tipo do lead (ex: `PF`, `PJ`).

- `leadTemperature` (number, body):
  Temperatura do lead, em número inteiro. Um valor que não seja inteiro devolve 400.

- `metadata` (object, body):
  Metadados adicionais do lead em formato JSON.

- `customFields` (object, body):
  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.

- `utms` (object, body):
  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"
  }
  ```

- `status` (string, body):
  Status do lead.

---

## Resposta

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

- `message` (string):
  Confirma que o lead foi atualizado com sucesso.

---

## Exemplos

### Exemplo de requisição

```bash PUT /api/v1/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"
  }
  }'
```

### Exemplo de resposta

```json 200
{
  "message": "Lead updated"
}
```

```json 404
{
  "error": "Lead not found"
}
```

```json 500
{
  "error": "Error to update lead"
}
```