Update task with the Capsule CRM API
Updates a task; fields left out stay unchanged. Set status to COMPLETED to complete it.
- Identifier
- capsule_update_task
The request
POST https://connect.reportei.com/api/tools/capsule_update_task/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"taskId": 1,
"task": {}
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | integer | Yes | Id of the task, from List tasks or Create task. |
| task | object | Yes | The fields to change. |
Supported connections
Your customer connects their Capsule CRM account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/capsule, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/capsule_update_task. It becomes your agent's tool definition with no conversion.
Other Capsule CRM tools
- 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.
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.
