Skip to main content
POST
/
user
/
lead
Criar lead
curl --request POST \
  --url https://suasofia.online/api/user/lead \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>",
  "campaign_id": 123,
  "variables": {
    "customer_name": "<string>",
    "email": "<string>"
  },
  "allow_dupplicate": true,
  "secondary_contacts": [
    {
      "phone_number": "<string>",
      "variables": {
        "customer_name": "<string>",
        "email": "<string>"
      }
    }
  ]
}
'
{
  "message": "Lead criado com sucesso",
  "data": {
    "id": 1,
    "campaign_id": 1,
    "phone_number": "+1234567890",
    "variables": {
      "customer_name": "João Silva",
      "email": "joao.silva@exemplo.com"
    },
    "status": "created",
    "created_at": "2025-06-30 11:53:20",
    "updated_at": "2025-06-30 11:53:20",
    "campaign": {
      "id": 1,
      "name": "Minha nova campanha"
    },
    "secondary_contacts": [
      {
        "id": 2,
        "phone_number": "+1234567891",
        "variables": {
          "customer_name": "Maria Silva Secundário",
          "email": "maria.silva.secundario@exemplo.com"
        },
        "status": "created",
        "created_at": "2025-06-30 11:53:20",
        "updated_at": "2025-06-30 11:53:20"
      },
      {
        "id": 3,
        "phone_number": "+1234567892",
        "variables": {
          "customer_name": "Roberto Silva Escritório",
          "email": "roberto.silva.escritorio@exemplo.com"
        },
        "status": "created",
        "created_at": "2025-06-30 11:53:20",
        "updated_at": "2025-06-30 11:53:20"
      }
    ]
  }
}
Este endpoint permite que você crie um novo lead para o usuário autenticado.

​
Corpo da requisição

​
phone_number
string
required
O número de telefone do lead no formato E.164 (por exemplo, +1234567890)
​
campaign_id
integer
required
O ID da campanha para criar o lead
​
variables
object
Variáveis personalizadas para passar para o lead. Você pode incluir quaisquer variáveis que estejam definidas no seu assistente (veja Variáveis de chamada). Os exemplos abaixo são apenas para ilustração — use seus próprios nomes de variáveis conforme configurado nas configurações do assistente.
​
allow_dupplicate
boolean
Se deve permitir leads duplicados em uma campanha.
​
secondary_contacts
array
Array de leads de contatos secundários a serem criados junto com o lead principal

​
Resposta

​
message
string
default:"Lead criado com sucesso"
A mensagem da resposta
​
data
object
O objeto de dados do lead
{
  "message": "Lead criado com sucesso",
  "data": {
    "id": 1,
    "campaign_id": 1,
    "phone_number": "+1234567890",
    "variables": {
      "customer_name": "João Silva",
      "email": "joao.silva@exemplo.com"
    },
    "status": "created",
    "created_at": "2025-06-30 11:53:20",
    "updated_at": "2025-06-30 11:53:20",
    "campaign": {
      "id": 1,
      "name": "Minha nova campanha"
    },
    "secondary_contacts": [
      {
        "id": 2,
        "phone_number": "+1234567891",
        "variables": {
          "customer_name": "Maria Silva Secundário",
          "email": "maria.silva.secundario@exemplo.com"
        },
        "status": "created",
        "created_at": "2025-06-30 11:53:20",
        "updated_at": "2025-06-30 11:53:20"
      },
      {
        "id": 3,
        "phone_number": "+1234567892",
        "variables": {
          "customer_name": "Roberto Silva Escritório",
          "email": "roberto.silva.escritorio@exemplo.com"
        },
        "status": "created",
        "created_at": "2025-06-30 11:53:20",
        "updated_at": "2025-06-30 11:53:20"
      }
    ]
  }
}