Listar oportunidades no Keap, por uma API
Lista as oportunidades do funil de vendas em opportunities, cada uma com seu contato, etapa e usuário, e next_page_token para a página seguinte.
- Identificador
- keap_list_opportunities
A chamada
POST https://connect.reportei.com/api/tools/keap_list_opportunities/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"filter": "<filter>"
}
}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 |
|---|---|---|---|
| filter | string | Não | Filters joined by ;, each one field==value, for example stage_id==3;user_id==5. Fields: stage_id (from List opportunity stages), user_id (from List users), contact_id (from List contacts), opportunity_title (with * for a prefix), ids (comma-separated, from List opportunities, up to 100), projected_revenue_low and projected_revenue_high (also with greater-than or less-than comparisons). |
| order_by | string | Não | Field and direction separated by a space: next_action_time, contact_name, opportunity_title, created_time or update_time, then asc or desc, for example created_time desc. |
| page_size | integer | Não | Opportunities per page, up to 1000. |
| page_token | string | Não | The next_page_token of the previous response. Omit it on the first page. |
Conexões possíveis
O seu cliente conecta a conta do Keap uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/keap, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
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/keap_list_opportunities. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Keap
- Listar contatosGETLista os contatos do app Keap em contacts, com next_page_token para a página seguinte. Sem fields, cada contato vem com um conjunto padrão de propriedades. Filtre por email, nome, ids e outros campos com filter.
- Criar contatoPOSTCria um contato e o retorna. Exige ao menos um item em email_addresses, phone_numbers ou addresses. Com duplicate_option, um contato correspondente é atualizado em vez de criar um novo.
- Atualizar contatoPATCHAtualiza os campos enviados e retorna o contato. Campos omitidos mantêm os valores, mas cada lista enviada (email_addresses, phone_numbers, addresses) substitui a lista inteira.
- Listar tagsGETLista as tags do app Keap em tags, com id, name, description e category, e next_page_token para a página seguinte.
- Criar tagPOSTCria uma tag e a retorna com seu id. A tag não é aplicada a ninguém até Aplicar tag.
- Aplicar tagPOSTAplica uma tag a um ou mais contatos. Aplicar uma tag pode disparar as automações do app Keap que a escutam, como sequências de email.
- Remover tagPOSTRemove uma tag de um ou mais contatos. A tag em si continua no app Keap.
- Criar oportunidadePOSTCria uma oportunidade para um contato em uma etapa do funil e a retorna. opportunity_title, contact_id e stage_id são obrigatórios.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
