Skip to main content
POST
/
v1
/
leads
curl --request POST \ --url https://api.integrabot.ai/v1/leads \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Maria Silva", "type": "whatsapp", "phone_number": "5511999998888", "email": "maria@exemplo.com", "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "custom_fields": { "empresa": "Acme Ltda", "cidade": "São Paulo" } } '
{
  "id": 1001,
  "name": "Maria Silva",
  "type": "whatsapp",
  "phone_number": "5511999998888",
  "email": "maria@exemplo.com",
  "status": "contacted",
  "agent_id": null,
  "custom_fields": {},
  "created_at": "2025-01-10T08:15:00Z",
  "updated_at": "2025-01-14T16:45:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Nome completo do lead

Example:

"Maria Silva"

​
type
enum<string>
required

Canal de origem do lead

Available options:
whatsapp,
email,
web,
manual,
instagram
Example:

"whatsapp"

​
phone_number
string

Número de telefone. Obrigatório quando type for whatsapp. Formato: DDI+DDD+Numero, apenas dígitos.

Example:

"5511999998888"

​
email
string<email>

Endereço de e-mail do lead

Example:

"maria@exemplo.com"

​
agent_id
string<uuid>

UUID do agent ao qual o lead será atribuído. Se não informado, o lead fica sem agent.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
custom_fields
object

Campos personalizados como pares chave-valor. Use para armazenar informações extras do lead.

Example:
{
  "empresa": "Acme Ltda",
  "cidade": "São Paulo"
}

Response

Lead já existia. Retorna o lead existente sem criar duplicata.

​
id
integer
Example:

1234

​
name
string
Example:

"Maria Silva"

​
type
enum<string>
Available options:
whatsapp,
email,
web,
manual,
instagram
Example:

"whatsapp"

​
phone_number
string | null
Example:

"5511999998888"

​
email
string | null
Example:

"maria@exemplo.com"

​
status
enum<string>
Available options:
new,
contacted,
qualified,
lost,
converted
Example:

"new"

​
agent_id
string<uuid> | null
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
custom_fields
object
Example:
{
  "empresa": "Acme Ltda",
  "cidade": "São Paulo"
}
​
created_at
string<date-time>
Example:

"2025-01-15T10:30:00Z"

​
updated_at
string<date-time>
Example:

"2025-01-15T14:22:00Z"