> ## Documentation Index
> Fetch the complete documentation index at: https://mayahub.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar lead

> Atualizar um lead existente em suas campanhas 

Atualize um lead fornecendo o ID do lead e os campos que deseja modificar.\
Somente os campos fornecidos na solicitação serão atualizados.

## Parâmetros de Caminho

<ParamField path="id" type="integer" required>
  O ID do lead a ser atualizado
</ParamField>

## Parâmetros do corpo

<ParamField body="campaign_id" type="integer">
  O ID da campanha à qual o lead será atribuído
</ParamField>

<ParamField body="phone_number" type="string">
  O número de telefone do lead (será formatado para E.164)
</ParamField>

<ParamField body="status" type="string">
  O status do lead. Deve ser um dos seguintes: `created`, `completed`, `reached-max-retries`
</ParamField>

<ParamField body="variables" type="object">
  Variáveis personalizadas para mesclar com as variáveis existentes do lead
</ParamField>

## Respostas

<ResponseField name="message" type="string">
  Mensagem de sucesso indicando que o lead foi atualizado
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X PUT "https://app.mayahub.ai/api/user/leads/123" \
    -H "Authorization: Bearer YOUR_API_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "campaign_id": 456,
      "phone_number": "+1234567890",
      "variables": {
        "name": "John Doe",
        "company": "Acme Corp"
      }
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Success Response theme={null}
  {
    "message": "Lead updated successfully"
  }
  ```

  ```json Error Response - Lead Not Found theme={null}
  {
    "message": "Lead not found"
  }
  ```

  ```json Error Response - Campaign Not Found theme={null}
  {
    "message": "Campaign not found"
  }
  ```

  ```json Error Response - Invalid Phone Number theme={null}
  {
    "message": "Invalid phone number"
  }
  ```

  ```json Error Response - Validation Failed theme={null}
  {
    "message": "Validation failed",
    "errors": {
      "campaign_id": ["The selected campaign does not exist"],
      "status": ["This status is assigned automatically and cannot be set manually"],
      "variables": ["Variables must be an array"]
    }
  }
  ```

  ```json Error Response - Invalid Fields theme={null}
  {
    "message": "Invalid fields: invalid_field, another_invalid_field"
  }
  ```
</ResponseExample>

## **Observações**

* O lead deve pertencer ao usuário autenticado.
* Se estiver atualizando a campanha, a nova campanha também deve pertencer ao usuário autenticado.
* Os números de telefone são automaticamente formatados e validados.
* As variáveis são mescladas com as variáveis existentes (não substituídas).
* Somente os campos permitidos podem ser atualizados: **campaign\_id**, **phone\_number**, **status**, **variables**.
* O campo **status** possui valores restritos para garantir a integridade dos dados.