Skip to main content
POST
Criar lead

Authorizations

X-API-Key
string
header
required

Chave de API gerada na plataforma em Integrações → API Keys

Body

application/json
customer_phone
string
required

Número no formato E.164

Example:

"5511999998888"

name
string
Example:

"João Silva"

status
enum<string>
default:pending
Available options:
pending,
in_progress,
converted,
lost

Response

Lead criado com sucesso

id
string<uuid>

Identificador único do lead

store_id
string<uuid>

ID da loja

name
string | null

Nome do lead

customer_phone
string

Telefone no formato E.164 (ex: 5511999998888)

status
enum<string>

Status atual do lead

Available options:
pending,
in_progress,
converted,
lost
seller_id
string<uuid> | null

Vendedor responsável

interaction_count
integer

Número de interações realizadas

ai_paused_until
string<date-time> | null

IA pausada até esta data/hora

created_at
string<date-time>
updated_at
string<date-time>