Skip to main content
POST
/
lead
Criar Lead
curl --request POST \
  --url https://sell.ia.proativia.com/api/v1/lead \
  --header 'Content-Type: application/json' \
  --header 'Token: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "<string>",
  "leadOwner": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone": "5547999999999",
  "source": "<string>",
  "profileImage": "<string>",
  "zipCode": "<string>",
  "state": "<string>",
  "city": "<string>",
  "neighborhood": "<string>",
  "streetAddress": "<string>",
  "number": "<string>",
  "complement": "<string>",
  "description": "<string>",
  "leadType": "<string>",
  "leadTemperature": 123,
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

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>