Star Tasks

POST /v1/nexttask/tasks/star

Star several tasks

Stars the tasks, or unstars them with starred false. Answers as the bulk call does.

Request

POST https://your-site.example/api/index.php/v1/nexttask/tasks/star

Request body

Content type: application/json

Field	Type	Required	Description
`ids`	`integer[]`	Yes
`starred`	`boolean`	Yes

{
    "ids": [
        3,
        4
    ],
    "starred": true
}

Responses

`200` — The action, the tasks it changed and any next occurrences it created.

{
    "success": true,
    "message": "string",
    "messages": "string",
    "data": {
        "action": "string",
        "ids": [
            1
        ],
        "items": [
            {
                "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
            }
        ],
        "clones": [
            {
                "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.
`422`		`VALIDATION`, `NESTING` or `QUOTA`, with the reason in `message`.

Examples

curl

curl -s -X POST "https://your-site.example/api/index.php/v1/nexttask/tasks/star" \
  -H "X-Joomla-Token: $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ids":[3,4],"starred":true}'

PHP

<?php
$ch = curl_init('https://your-site.example/api/index.php/v1/nexttask/tasks/star');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'X-Joomla-Token: ' . getenv('API_TOKEN'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => '{"ids":[3,4],"starred":true}',
]);

$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/star", {
  method: 'POST',
  headers: {
    "X-Joomla-Token": `${API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "ids": [
      3,
      4
    ],
    "starred": true
  }),
});
const data = await response.json();