Skip to main content
POST
/
leads
Criar lead
curl --request POST \
  --url https://api.cordialy.ai/integrations/v1/leads \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customer_phone": "5511999998888",
  "name": "João Silva",
  "status": "pending"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "store_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "customer_phone": "<string>",
  "seller_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "interaction_count": 123,
  "ai_paused_until": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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>