v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Leads

Criar um novo lead

Cria um novo lead com base nos dados fornecidos

post/{alias}/leads

Path parameters

aliasstring required

Alias da loja

Request body

namestring

O nome do lead

emailstring email required

O endereço de email do lead

birthdaystring date

Data de nascimento do lead

citystring

Cidade do lead

statestring

Estado do lead

genrestring

Gênero do lead

paramsobject

Parâmetros adicionais

utm_sourcestring

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

utm_campaignstring

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

utm_mediumstring

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

utm_termstring

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

utm_contentstring

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

Example request

{
  "name": "Nome do lead",
  "email": "lead@exemplo.com",
  "birthday": "yyyy-mm-dd",
  "city": "São Paulo",
  "state": "SP",
  "genre": "m",
  "params": {
    "foo": "Bar",
    "param2": "Param2Value"
  },
  "utm_source": "google",
  "utm_campaign": "promo_verao",
  "utm_medium": "cpc",
  "utm_term": "sapatos",
  "utm_content": "banner_lateral"
}

Response

Lead criado com sucesso

idinteger

merchant_idinteger

namestring

emailstring

birthdaystring date

citystring

statestring

genrestring

utm_sourcestring

utm_campaignstring

utm_mediumstring

utm_termstring

utm_contentstring

paramsstring

is_customerboolean

customer_idinteger

customer_sincestring date

Example response

{
  "name": "Nome do Lead",
  "email": "lead@email.com",
  "birthday": "yyyy-mm-dd",
  "city": "São Paulo",
  "state": "SP",
  "genre": "m",
  "customer_since": "yyyy-mm-dd",
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}