Tools do Capsule CRM
As 15 operações do Capsule CRM que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- 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.
- Criar oportunidadePOSTCria uma oportunidade para uma party, em um milestone de um pipeline. name, party e milestone são obrigatórios.
- 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.
- Listar milestones do pipelineGETLista os milestones de um pipeline, com a probabilidade de cada um; complete é true nos que encerram a oportunidade, como Won e Lost. Use o id de um milestone como milestone nas ferramentas de oportunidades.
- Listar usuáriosGETLista os usuários da conta, com name e username. Use o id de um usuário como owner nas ferramentas de parties, oportunidades e tarefas.
- Listar tarefasGETLista as tarefas da conta, apenas as abertas, a menos que status diga outra coisa. Cada tarefa tem dueOn, owner e a party ou oportunidade a que está vinculada. Pagine com page, começando em 1, e perPage, até 100.
- Criar tarefaPOSTCria uma tarefa com prazo em dueOn, opcionalmente às dueTime, vinculada a uma party ou a uma oportunidade, nunca às duas. description e dueOn são obrigatórios.
- Atualizar tarefaPUTAtualiza uma tarefa; os campos omitidos não mudam. Defina status como COMPLETED para concluí-la.
- Excluir tarefaDELETEExclui uma tarefa em definitivo. Para encerrar uma tarefa que foi feita, use Atualizar tarefa com status COMPLETED.
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.
