Skip to content
WorkRoad home
REST API

Update one notification kind

PATCH
/settings/notifications/{kind}

Turns a kind's bell, email or push on or off, or changes when it is sent. Returns the kind as it now resolves.

Required scopes: settings:update

Authorization

headerAuthorizationBearer <token>

Path Parameters

kind*string

TASK_DUE before a task is due, EXAM_SOON before an exam, STREAK_AT_RISK when today's goal isn't met, LESSON_STARTING before a lesson, SCHEDULE_SHARE_CHANGED when someone shares a timetable or stops, GENERATION_FINISHED and RECORDING_READY when AI work finishes, DIGEST for the email digest.

Value in"TASK_DUE""EXAM_SOON""STREAK_AT_RISK""LESSON_STARTING""SCHEDULE_SHARE_CHANGED""GENERATION_FINISHED""RECORDING_READY""DIGEST"

Request Body

application/json
  1. body

Send only the fields to change. An omitted field stays as it is. A timing field the kind doesn't use, or a value off its list, fails with 400.

inApp?boolean
email?boolean
push?boolean
leadMinutes?|

TASK_DUE: 15, 60, 180, 1440. LESSON_STARTING: 5, 10, 15, 30. Null restores the default.

leadDays?|

TASK_DUE (all-day tasks): 0, 1, 2. EXAM_SOON: 1, 2, 3, 5, 7, 14; one value replaces the default of 3 days and 1 day before. Null restores the default.

localTime?|

HH:MM for TASK_DUE (all-day tasks), EXAM_SOON and STREAK_AT_RISK. Null restores the default.

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://workroad.app/api/v1/settings/notifications/TASK_DUE' \  -H 'Authorization: Bearer $WORKROAD_API_KEY' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "kind": "TASK_DUE",    "inApp": true,    "email": false,    "push": true,    "leadMinutes": 60,    "leadDays": [      1    ],    "localTime": "18:00"  }}

Resume notification email POST

Turns notification email back on after it was suppressed because a message bounced or was reported as spam.

Update notification settings PATCH

Changes quiet hours, the digest, push content or calendar alarms.