Skip to main content
POST
Criar um novo lead

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Body

application/json

Representa os dados necessários para criar ou atualizar um lead

email
string<email>
required

O endereço de email do lead

Example:

"lead@exemplo.com"

name
string

O nome do lead

Example:

"Nome do lead"

birthday
string<date>

Data de nascimento do lead

Example:

"yyyy-mm-dd"

city
string

Cidade do lead

Example:

"São Paulo"

state
string

Estado do lead

Example:

"SP"

genre
string

Gênero do lead

Example:

"m"

params
object

Parâmetros adicionais

Example:
utm_source
string

Origem da campanha UTM. O valor é sanitizado e normalizado automaticamente.

Example:

"google"

utm_campaign
string

Nome da campanha UTM. O valor é sanitizado e normalizado automaticamente.

Example:

"promo_verao"

utm_medium
string

Mídia da campanha UTM. O valor é sanitizado e normalizado automaticamente.

Example:

"cpc"

utm_term
string

Termo da campanha UTM. O valor é sanitizado e normalizado automaticamente.

Example:

"sapatos"

utm_content
string

Conteúdo da campanha UTM. O valor é sanitizado e normalizado automaticamente.

Example:

"banner_lateral"

Response

Lead criado com sucesso

Representa um lead da lista de leads

id
integer
merchant_id
integer
read-only
Example:

"1"

name
string
Example:

"Nome do Lead"

email
string
Example:

"lead@email.com"

birthday
string<date>
Example:

"yyyy-mm-dd"

city
string
Example:

"São Paulo"

state
string
Example:

"SP"

genre
string
Example:

"m"

utm_source
string
Example:

""

utm_campaign
string
Example:

""

utm_medium
string
Example:

""

utm_term
string
Example:

""

utm_content
string
Example:

""

params
string
Example:
is_customer
boolean
Example:

"true"

customer_id
integer
Example:

"123"

customer_since
string<date>
Example:

"yyyy-mm-dd"

created_at
object
updated_at
object