Criar oportunidade no Capsule CRM, por uma API
Cria uma oportunidade para uma party, em um milestone de um pipeline. name, party e milestone são obrigatórios.
- Identificador
- capsule_create_opportunity
A chamada
POST https://connect.reportei.com/api/tools/capsule_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": {}
}
}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 | object | Sim | The opportunity to create. |
Conexões possíveis
O seu cliente conecta a conta do Capsule CRM 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.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/capsule, 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/capsule_create_opportunity. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Capsule CRM
- Listar partiesGETLista as pessoas e organizações da conta, 50 por página por padrão. Pagine com page, começando em 1, e perPage, até 100; uma página menor que perPage é a última.
- Buscar partiesGETBusca pessoas e organizações com os mesmos resultados da busca global do Capsule, por nome, CEP ou telefone, por exemplo. Pagine com page, começando em 1, e perPage, até 100.
- Obter partyGETRetorna uma pessoa ou organização, com seus e-mails, telefones, endereços e sites e o id de cada um.
- Criar partyPOSTCria uma pessoa ou uma organização. Envie firstName e lastName para uma pessoa e name para uma organização. organisation vincula uma pessoa por id, ou por nome, o que cria a organização se ela ainda não existir. Sem owner, a party vai para o usuário conectado.
- Atualizar partyPUTAtualiza uma pessoa ou organização; os campos omitidos não mudam. Nos arrays, um item sem id é adicionado, um item com id é alterado e um item com id e _delete true é removido. Os ids vêm de Obter party.
- Listar oportunidadesGETLista as oportunidades da conta, com party, milestone, value e expectedCloseOn, 50 por página por padrão. Pagine com page, começando em 1, e perPage, até 100; uma página menor que perPage é a última.
- Atualizar oportunidadePUTAtualiza uma oportunidade; os campos omitidos não mudam. Movê-la para outro milestone, como Won ou Lost, é uma mudança de milestone.
- Listar pipelinesGETLista os pipelines de vendas da conta. Use o id de um pipeline em Listar milestones do pipeline.
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.
