Skip to main content
POST
/
lead
curl --request POST \
  --url 'https://sell.ia.proativia.com/api/v1/lead' \
  --header 'Token: SEU_TOKEN_DE_API' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Maria Souza",
    "email": "maria@email.com",
    "phone": "5511988887777",
    "source": "site",
    "leadType": "PF",
    "leadTemperature": 3,
    "status": "Lead"
  }'

{
  "id": "clxyz5678",
  "leadOwner": null,
  "name": "Maria Souza",
  "email": "maria@email.com",
  "phone": "5511988887777",
  "source": "site",
  "profileImage": null,
  "zipCode": null,
  "state": null,
  "city": null,
  "neighborhood": null,
  "streetAddress": null,
  "number": null,
  "complement": null,
  "description": null,
  "leadType": "PF",
  "leadTemperature": 3,
  "status": "Lead",
  "createdAt": "2025-06-15T14:30:00.000Z",
  "updatedAt": "2025-06-15T14:30:00.000Z"
}

​
Requisição

​
Token
string
required
Seu token de autenticação.

​
Body

​
name
string
required
Nome do lead.
​
email
string
E-mail do lead.
​
phone
string
Telefone do lead.
O número deve estar no formato 5547999999999 (código do país + DDD + número, sem espaços, traços ou parênteses). Qualquer outro formato — como 47 999999999 ou (47) 99999-9999 — causará erros nos disparos via WhatsApp.
​
source
string
Origem do lead (ex: site, instagram, indicacao).
​
leadOwner
string
ID do usuário responsável pelo lead.
​
profileImage
string
URL da imagem de perfil do lead.
​
zipCode
string
CEP do endereço do lead.
​
state
string
Estado do lead.
​
city
string
Cidade do lead.
​
neighborhood
string
Bairro do lead.
​
streetAddress
string
Logradouro do lead.
​
number
string
Número do endereço.
​
complement
string
Complemento do endereço.
​
description
string
Descrição ou observações sobre o lead.
​
leadType
string
Tipo do lead (ex: PF, PJ).
​
leadTemperature
number
Temperatura do lead como valor numérico.
​
status
string
Status inicial do lead. Padrão: Lead.

​
Resposta

Retorna o objeto do lead criado com todos os campos, incluindo o accountId.
​
id
string
Identificador único do lead criado.
​
accountId
string
ID da conta à qual o lead pertence.
​
leadOwner
string | null
ID do usuário responsável.
​
name
string
Nome do lead.
​
email
string | null
E-mail do lead.
​
phone
string | null
Telefone do lead.
​
source
string | null
Origem do lead.
​
profileImage
string | null
URL da imagem de perfil.
​
zipCode
string | null
CEP.
​
state
string | null
Estado.
​
city
string | null
Cidade.
​
neighborhood
string | null
Bairro.
​
streetAddress
string | null
Logradouro.
​
number
string | null
Número do endereço.
​
complement
string | null
Complemento.
​
description
string | null
Descrição ou observações.
​
leadType
string | null
Tipo do lead.
​
leadTemperature
number | null
Temperatura do lead: 1 (Frio), 2 (Morno) ou 3 (Quente).
​
status
string
Status do lead.
​
createdAt
string
Data de criação (ISO 8601).
​
updatedAt
string
Data da última atualização (ISO 8601).

​
Exemplos

curl --request POST \
  --url 'https://sell.ia.proativia.com/api/v1/lead' \
  --header 'Token: SEU_TOKEN_DE_API' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Maria Souza",
    "email": "maria@email.com",
    "phone": "5511988887777",
    "source": "site",
    "leadType": "PF",
    "leadTemperature": 3,
    "status": "Lead"
  }'

{
  "id": "clxyz5678",
  "leadOwner": null,
  "name": "Maria Souza",
  "email": "maria@email.com",
  "phone": "5511988887777",
  "source": "site",
  "profileImage": null,
  "zipCode": null,
  "state": null,
  "city": null,
  "neighborhood": null,
  "streetAddress": null,
  "number": null,
  "complement": null,
  "description": null,
  "leadType": "PF",
  "leadTemperature": 3,
  "status": "Lead",
  "createdAt": "2025-06-15T14:30:00.000Z",
  "updatedAt": "2025-06-15T14:30:00.000Z"
}

Authorizations

​
Token
string
header
required

Token de autenticacao gerado na plataforma Sell.IA.

Body

application/json
​
name
string
required

Nome do lead.

​
email
string

E-mail do lead.

​
phone
string

Telefone no formato internacional sem simbolos: 5547999999999 (pais + DDD + numero). Outros formatos causarao erros nos disparos via WhatsApp.

Example:

"5547999999999"

​
source
string

Origem do lead (ex: site, instagram, indicacao).

​
leadOwner
string

ID do usuario responsavel pelo lead.

​
profileImage
string

URL da imagem de perfil do lead.

​
zipCode
string

CEP do endereco.

​
state
string

Estado.

​
city
string

Cidade.

​
neighborhood
string

Bairro.

​
streetAddress
string

Logradouro.

​
number
string

Numero do endereco.

​
complement
string

Complemento do endereco.

​
description
string

Descricao ou observacoes sobre o lead.

​
leadType
string

Tipo do lead (ex: PF, PJ).

​
leadTemperature
enum<integer>

Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).

Available options:
1,
2,
3
​
status
string

Status inicial do lead. Padrao: Lead.

Response

Lead criado com sucesso.

​
id
string
​
leadOwner
string | null
​
name
string
​
email
string | null
​
phone
string | null

Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos ou simbolos).

Example:

"5547999999999"

​
source
string | null
​
profileImage
string | null
​
zipCode
string | null
​
state
string | null
​
city
string | null
​
neighborhood
string | null
​
streetAddress
string | null
​
number
string | null
​
complement
string | null
​
description
string | null
​
leadType
string | null
​
leadTemperature
number | null

Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).

​
status
string
​
createdAt
string<date-time>