Skip to main content
POST
Criar Lead

Authorizations

Token
string
header
required

Token de autenticacao gerado na plataforma WavUps CRM.

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"

taxId
string

CPF ou CNPJ do lead.

Example:

"12345678909"

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.

metadata
object | null

Metadados adicionais do lead em formato JSON.

utms
object | null

Parâmetros UTM associados ao lead em formato JSON.

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"

taxId
string | null

CPF ou CNPJ do lead.

Example:

"12345678909"

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
metadata
object | null

Metadados adicionais do lead em formato JSON.

utms
object | null

Parâmetros UTM associados ao lead em formato JSON.

createdAt
string<date-time>