Capsule CRM tools
The 15 Capsule CRM operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List partiesGETLists the people and organisations of the account, 50 per page by default. Paginate with page, starting at 1, and perPage, up to 100; a page shorter than perPage is the last one.
- Search partiesGETSearches people and organisations with the same results as the global search of Capsule, by a name, a postcode or a phone number, for example. Paginate with page, starting at 1, and perPage, up to 100.
- Get partyGETReturns one person or organisation, with its email addresses, phone numbers, addresses and websites and the id of each of them.
- Create partyPOSTCreates a person or an organisation. Send firstName and lastName for a person and name for an organisation. organisation links a person by id, or by name, which creates the organisation when it does not exist yet. Without owner, the party goes to the connected user.
- Update partyPUTUpdates a person or an organisation; fields left out stay unchanged. In the arrays, an item without id is added, an item with id is changed, and an item with id and _delete set to true is removed. The ids come from Get party.
- List opportunitiesGETLists the opportunities of the account, with party, milestone, value and expectedCloseOn, 50 per page by default. Paginate with page, starting at 1, and perPage, up to 100; a page shorter than perPage is the last one.
- Create opportunityPOSTCreates an opportunity for a party, at a milestone of a pipeline. name, party and milestone are required.
- Update opportunityPUTUpdates an opportunity; fields left out stay unchanged. Moving it to another milestone, such as Won or Lost, is a change of milestone.
- List pipelinesGETLists the sales pipelines of the account. Use the id of a pipeline in List pipeline milestones.
- List pipeline milestonesGETLists the milestones of a pipeline, with the probability of each; complete is true on the ones that close the opportunity, such as Won and Lost. Use the id of a milestone as milestone in the opportunity tools.
- List usersGETLists the users of the account, with name and username. Use the id of a user as owner in the party, opportunity and task tools.
- List tasksGETLists the tasks of the account, only the open ones unless status says otherwise. Each task has dueOn, owner and the party or opportunity it is linked to. Paginate with page, starting at 1, and perPage, up to 100.
- Create taskPOSTCreates a task due on dueOn, optionally at dueTime, linked to a party or to an opportunity, never both. description and dueOn are required.
- Update taskPUTUpdates a task; fields left out stay unchanged. Set status to COMPLETED to complete it.
- Delete taskDELETEDeletes a task for good. To close a task that was done, use Update task with status COMPLETED instead.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
