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âmetroTipoObrigatórioDescrição
campaignstringNãoOnly leads of this campaign, by the id from List campaigns.
list_idstringNãoOnly leads of this lead list, by the id from List lead lists.
searchstringNãoWhole 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.
filterstringNãoOnly 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
contactsarrayNãoOnly leads with these emails.
idsarrayNãoOnly these leads, by the id from a previous call of List leads.
in_campaignbooleanNãoTrue for leads that are in a campaign, false for leads outside any campaign.
in_listbooleanNãoTrue for leads that are in a lead list, false for leads outside any list.
limitintegerNãoLeads per page, up to 100.
starting_afterstringNãoThe 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.

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.