PUT /api/v2/task_lists/{task_list_id}/task_items/{task_item_id}
Updates a task item. Available fields depend on the item type:
Any task item: Use completed to mark the item complete (true) or incomplete (false). This is reflected as is_completed in the response. Completing all task items in a task list automatically marks the task list as completed.
Custom task items only: Also supports updating name and description. Template-based task items cannot be renamed.
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
task_list_id |
String | Yes |
The id of the task list |
task_item_id |
String | Yes |
The id of the task item |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
task_item |
Object | No | |
task_item.completed |
Boolean | No |
If true, marks the task item as complete. The response returns the completion status in |
task_item.name |
String | No |
The name of the task item |
task_item.description |
String | No |
The description of the task item |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.