Atualizar lead

Atualizar um lead existente em suas campanhas

PUT /user/leads/{id}

cURL

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": "[phone]",
    "variables": {
      "name": "John Doe",
      "company": "Acme Corp"
    }
  }'

Success Response

{
  "message": "Lead updated successfully"
}

{
  "message": "Lead not found"
}

{
  "message": "Campaign not found"
}

{
  "message": "Invalid phone number"
}

{
  "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"]
  }
}

{
  "message": "Invalid fields: invalid_field, another_invalid_field"
}

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

id · integer · required

O ID do lead a ser atualizado

Parâmetros do corpo

campaign_id · integer

O ID da campanha à qual o lead será atribuído

phone_number · string

O número de telefone do lead (será formatado para E.164)

status · string

O status do lead. Deve ser um dos seguintes: created, completed, reached-max-retries

variables · object

Variáveis personalizadas para mesclar com as variáveis existentes do lead

Respostas

message · string

Mensagem de sucesso indicando que o lead foi atualizado

cURL

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": "[phone]",
    "variables": {
      "name": "John Doe",
      "company": "Acme Corp"
    }
  }'

Success Response

{
  "message": "Lead updated successfully"
}

{
  "message": "Lead not found"
}

{
  "message": "Campaign not found"
}

{
  "message": "Invalid phone number"
}

{
  "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"]
  }
}

{
  "message": "Invalid fields: invalid_field, another_invalid_field"
}

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.