Update Task
PATCH /v1/nexttask/tasks/{id}
Change a task
Changes only the fields sent. Needs Tasks > Edit and edit access to its list.
Request
PATCH https://your-site.example/api/index.php/v1/nexttask/tasks/{id}
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id |
integer |
path |
Yes | The record the call is about. An id or ids in the body is ignored. |
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
title |
string |
No | |
list_id |
integer |
No | |
parent_id |
integer |
No | The parent task; 0 or empty for a top-level task. |
notes |
string |
No | |
due |
string |
No | YYYY-MM-DD HH:MM:SS in the site's time zone. |
has_time |
integer |
No | 1 when the time of due counts. |
starred |
integer |
No | |
assigned_to |
integer |
No | Someone who can reach the list; anyone else is refused with 422. |
links |
object[] |
No |
{
"notes": "Call before noon",
"starred": 1
}
Responses
200 — The task.
{
"success": true,
"message": "string",
"messages": "string",
"data": {
"item": {
"id": 12,
"list_id": 5,
"parent_id": 0,
"title": "Ship it",
"notes": "string",
"status": "needsAction",
"starred": 1,
"due": "2026-10-02 09:00:00",
"has_time": 1,
"recurrence": "string",
"recurrence_next_id": 1,
"completed_time": "string",
"position": "string",
"links": [
{}
],
"assigned_to": 1,
"assignee_name": "string",
"subtask_count": 1,
"completed_subtask_count": 1,
"access": "owner",
"can_complete": true,
"deleted_time": "string",
"created": "string",
"created_by": 1,
"modified": "string",
"modified_by": 1
}
}
}
Errors
| Status | Code | When |
|---|---|---|
401 |
No valid API token. | |
403 |
FORBIDDEN when the role or the list does not allow it, APP_DISABLED when the feature's app is off. |
|
404 |
NOT_FOUND: no such record, or not one you can reach. |
|
422 |
VALIDATION, NESTING or QUOTA, with the reason in message. |
Examples
curl
curl -s -X PATCH "https://your-site.example/api/index.php/v1/nexttask/tasks/1" \
-H "X-Joomla-Token: $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"notes":"Call before noon","starred":1}'
PHP
<?php
$ch = curl_init('https://your-site.example/api/index.php/v1/nexttask/tasks/1');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-Joomla-Token: ' . getenv('API_TOKEN'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => '{"notes":"Call before noon","starred":1}',
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
JavaScript
const API_TOKEN = process.env.API_TOKEN;
const response = await fetch("https://your-site.example/api/index.php/v1/nexttask/tasks/1", {
method: 'PATCH',
headers: {
"X-Joomla-Token": `${API_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"notes": "Call before noon",
"starred": 1
}),
});
const data = await response.json();