Listar leads no Instantly, por uma API
Lista leads com email, nomes, empresa, status e status de interesse, até limit por página. Para a próxima página, passe next_starting_after como starting_after, até que ele deixe de voltar.
- Identificador
- instantly_list_leads
A chamada
POST https://connect.reportei.com/api/tools/instantly_list_leads/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"campaign": "<campaign>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| campaign | string | Não | Only leads of this campaign, by the id from List campaigns. |
| list_id | string | Não | Only leads of this lead list, by the id from List lead lists. |
| search | string | Não | Whole words, or the start of a value, matched against email, names, company and job title. Leads created a few seconds ago may not show yet. |
| filter | string | Não | Only leads in this state, like FILTER_VAL_REPLIED for leads that replied or FILTER_LEAD_INTERESTED for leads marked as interested.Valores: FILTER_VAL_CONTACTED, FILTER_VAL_NOT_CONTACTED, FILTER_VAL_COMPLETED, FILTER_VAL_UNSUBSCRIBED, FILTER_VAL_ACTIVE, FILTER_LEAD_INTERESTED, FILTER_LEAD_NOT_INTERESTED, FILTER_LEAD_MEETING_BOOKED, FILTER_LEAD_MEETING_COMPLETED, FILTER_LEAD_CLOSED, FILTER_LEAD_OUT_OF_OFFICE, FILTER_LEAD_WRONG_PERSON, FILTER_LEAD_LOST, FILTER_LEAD_NO_SHOW, FILTER_VAL_BOUNCED, FILTER_VAL_SKIPPED, FILTER_VAL_REPLIED, FILTER_VAL_OPENED_NO_REPLY, FILTER_VAL_COMPLETED_NO_REPLY, FILTER_VAL_NO_OPENS, FILTER_VAL_LINK_CLICKED |
| contacts | array | Não | Only leads with these emails. |
| ids | array | Não | Only these leads, by the id from a previous call of List leads. |
| in_campaign | boolean | Não | True for leads that are in a campaign, false for leads outside any campaign. |
| in_list | boolean | Não | True for leads that are in a lead list, false for leads outside any list. |
| limit | integer | Não | Leads per page, up to 100. |
| starting_after | string | Não | The next_starting_after of the previous page. |
Conexões possíveis
O seu cliente conecta a conta do Instantly uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/instantly_list_leads. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Instantly
- Listar campanhasGETLista as campanhas do workspace com id, nome e status, até limit por página. Para a próxima página, passe next_starting_after como starting_after, até que ele deixe de voltar.
- Obter campanhaGETRetorna uma campanha com status, agenda, sequences (os passos de email e suas variantes), contas de envio em email_list e opções de envio.
- Criar campanhaPOSTCria uma campanha como rascunho, com agenda, passos de email e contas de envio. Adicione leads com Create lead e inicie com Activate campaign.
- Atualizar campanhaPATCHAltera uma campanha. Envie só os campos a mudar; sequences e campaign_schedule substituem os atuais por inteiro.
- Ativar campanhaPOSTInicia uma campanha em rascunho ou retoma uma pausada. A Instantly passa então a enviar os passos aos leads da campanha, das contas em email_list, dentro da agenda.
- Pausar campanhaPOSTPausa uma campanha, e nenhum email sai até que Activate campaign a retome.
- Obter métricas da campanhaGETRetorna, por campanha, leads, contatados, emails enviados, aberturas, respostas, cliques em links, bounces, descadastros, leads concluídos e oportunidades, de uma campanha ou de todas.
- Criar leadPOSTAdiciona um lead a uma campanha ou a uma lista de leads. Um lead adicionado a uma campanha ativa entra na sequência e recebe emails conforme a agenda.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
