Skip to content
WorkRoad home
REST API

Update task preferences

PATCH
/settings/tasks

Replaces the task types or changes the due-date colours.

Required scopes: settings:update

Authorization

headerAuthorizationBearer <token>

Request Body

application/json
  1. body

Send only the fields to change. An omitted field stays as it is.

types?array<>

Replaces the whole list, in order. Tasks keep their type when it is removed here.

Items1 <= items <= 50
overdueColor?string

Overdue tasks, as #RRGGBB.

Match^#[0-9A-F]{6}$
dueTodayColor?string

Tasks due today, as #RRGGBB.

Match^#[0-9A-F]{6}$
nearlyDueColor?string

Tasks due soon, as #RRGGBB.

Match^#[0-9A-F]{6}$

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://workroad.app/api/v1/settings/tasks' \  -H 'Authorization: Bearer $WORKROAD_API_KEY' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "types": [      "Homework",      "Test",      "Study",      "Project"    ],    "overdueColor": "#ef4444",    "dueTodayColor": "#f97316",    "nearlyDueColor": "#eab308"  }}

Update review settings PATCH

Changes the limits, retention, daily goal or leech handling the review queue and practice sessions use.

Plan a study block POST

Puts study time on the user's calendar, the way the planning copilot does: a title, a future start and end in the user's time zone, and optionally the subject, task or study set it is for.