YAyampi
Leads

Criar um novo lead

Cria um novo lead com base nos dados fornecidos

post/{alias}/leads

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/leads
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

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

ID do lead.

merchant_idinteger

ID da loja dona do lead.

namestring

Nome do lead.

emailstring

E-mail informado pelo lead.

birthdaystring date

Data de nascimento do lead.

citystring

Cidade informada pelo lead.

statestring

Unidade federativa (estado) informada pelo lead.

genrestring

Gênero informado pelo lead: m para masculino e f para feminino.

utm_sourcestring

Origem da campanha de marketing (parâmetro UTM utm_source) que originou o lead.

utm_campaignstring

Nome da campanha de marketing (parâmetro UTM utm_campaign) que originou o lead.

utm_mediumstring

Meio/canal de marketing (parâmetro UTM utm_medium) que originou o lead.

utm_termstring

Termo de busca (parâmetro UTM utm_term) que originou o lead.

utm_contentstring

Conteúdo do anúncio/link (parâmetro UTM utm_content) que originou o lead.

paramsstring

Parâmetros adicionais enviados no cadastro do lead, no formato chave-valor.

is_customerboolean

Indica se o lead já se tornou cliente da loja.

customer_idinteger

ID do cliente correspondente ao lead, quando ele já tiver se tornado cliente da loja.

customer_sincestring date

Data em que o lead se tornou cliente da loja.

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"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.