Skip to content
WorkRoad home
REST API

Update review settings

PATCH
/settings/review

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

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. A change applies from the next card; today's goal stays as it was set this morning.

newPerDay?integer

0 to 2000.

Range0 <= value <= 2000
reviewsPerDay?|

0 to 10000, or null for no limit.

retention?number

0.7 to 0.99. Higher means more reviews and fewer forgotten cards.

Range0.7 <= value <= 0.99
goalKind?string
Value in"cards""minutes"
goalTarget?integer

1 to 2000.

Range1 <= value <= 2000
leechThreshold?integer

2 to 100.

Range2 <= value <= 100
suspendLeeches?boolean
subjectOverrides?array<>

Replaces every override when sent. Send an empty list to remove them all.

Itemsitems <= 200

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://workroad.app/api/v1/settings/review' \  -H 'Authorization: Bearer $WORKROAD_API_KEY' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "newPerDay": 20,    "reviewsPerDay": null,    "retention": 0.9,    "goalKind": "cards",    "goalTarget": 30,    "leechThreshold": 8,    "suspendLeeches": true,    "subjectOverrides": [      {        "subjectId": "5f0c1d2e-3a4b-4c5d-8e6f-7a8b9c0d1e2f",        "newPerDay": 10,        "reviewsPerDay": null,        "retention": 0.95      }    ],    "optimizedAt": null  }}

Update the profile PATCH

Changes the name, username, bio, status, location or what the public profile shows.

Update task preferences PATCH

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