Leads

Search…

Leads

Listar leads
GET https://api.dooki.com.br/v2/{alias}/leads
Request
{
    "name": "Lead Name",
    "email": "[email protected]",
    "birthday": "2017-05-05",
    "city": "São Paulo",
    "state": "SP",
    "genre": "m",
    "params": {
        "foo": "Bar",
        "param2": "Param2Value"
    },
}
Response
{
    "data": [
        {
            "id": 1,
            "name": "Lead Name",
            "email": "[email protected]",
            "birthday": "2017-05-05",
            "city": "São Paulo",
            "state": "SP",
            "genre": "m",
            "params": {
                "foo": "Bar",
                "param2": "Param2Value"
            },
        },
    ]
}
Criar lead
POST https://api.dooki.com.br/v2/{alias}/leads
Os leads serão sincronizados com os serviços ativos que o lojista possui integração, por exemplo: MailChimp, RD Station etc.
Parâmetro
Tipo
Obrigatório
Descrição
name
string
Não
Nome do lead.
email
string
Sim
E-mail do lead.
birthday
date
Não
Data de aniversário do lead. Formato: yyyy-mm-dd.
city
string
Não
Cidade do lead.
state
string
Não
Estado do lead.
genre
string
Não
Sexo do lead. Valores aceitos: m ou f.
params
array
Não
Parâmetros personalizados de acordo com sua necessidade.
Visualizar lead
GET https://api.dooki.com.br/v2/{alias}/leads/{id}
Atualizar lead
PUT https://api.dooki.com.br/v2/{alias}/leads/{id}
Excluir lead
DELETE https://api.dooki.com.br/v2/{alias}/leads/{id}
Listar filtros de busca
GET https://api.dooki.com.br/v2/{alias}/leads/filters
Exportar leads
GET https://api.dooki.com.br/v2/{alias}/leads/export
Dica: os filtros de busca também estão disponíveis no endpoint de exportação.
O sistema enviará para o usuário um e-mail com o link para download da planilha com os registros.
Exportar leads para um determinado serviço
GET https://api.dooki.com.br/v2/{alias}/leads/export/{service}
Serviços disponíveis: mailchimp, mailee e rdstation
Parâmetro
Descrição
queue_id
ID da fila que está processando a exportação.
total
Número de registros a serem exportados.
resource_link
URL para consultar o status da fila.
Response ao exportar os leads
{
    "queue_id": 53,
    "total": 133,
    "resource_link": "https://api.dooki.com.br/v2/{alias}/queues/53",
}

Referência da API - Previous

Catálogo

Next - Referência da API

Clientes

Last modified 2yr ago

Copy link

Outline

Listar filtros de busca

Exportar leads

Exportar leads para um determinado serviço