Criar oportunidade no Keap, por uma API
Cria uma oportunidade para um contato em uma etapa do funil e a retorna. opportunity_title, contact_id e stage_id são obrigatórios.
- Identificador
- keap_create_opportunity
A chamada
POST https://connect.reportei.com/api/tools/keap_create_opportunity/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"opportunity_title": "<opportunity_title>",
"contact_id": "<contact_id>",
"stage_id": "<stage_id>"
}
}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 |
|---|---|---|---|
| opportunity_title | string | Sim | Title of the opportunity. |
| contact_id | string | Sim | Id of the contact, from List contacts. |
| stage_id | string | Sim | Id of the pipeline stage, from List opportunity stages. |
| user_id | string | Não | Id of the user assigned to the opportunity, the id field of List users (not global_user_id). |
| projected_revenue_low | number | Não | Low estimate of the revenue. |
| projected_revenue_high | number | Não | High estimate of the revenue. |
| estimated_close_time | string | Não | Expected close date and time in ISO 8601, for example 2026-11-30T15:00:00Z. |
| next_action_time | string | Não | Date and time of the next action in ISO 8601. |
| next_action_notes | string | Não | What the next action is. |
| opportunity_notes | string | Não | General notes. |
| include_in_forecast | boolean | Não | Counts the opportunity in the sales forecast. |
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_create_opportunity. 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.
- Listar oportunidadesGETLista 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
