Skip to content
WorkRoad home
REST API

Update language, time zone or privacy

PATCH
/settings/preferences

Changing the time zone moves every task's due date so it keeps its date and time on the clock, the same as changing it in Settings → Account.

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.

locale?string

One of the five app languages.

Value in"en""de""es""fr""it"
timeZone?string

An IANA zone name. Aliases such as Asia/Calcutta are stored by their canonical name. Every task keeps its due date and time on the clock, so a task due at 09:00 is still due at 09:00 in the new zone.

Length1 <= length <= 64
showOnLeaderboards?boolean

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://workroad.app/api/v1/settings/preferences' \  -H 'Authorization: Bearer $WORKROAD_API_KEY' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "locale": "en",    "timeZone": "Europe/London",    "showOnLeaderboards": true  }}

Update notification settings PATCH

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

Update the profile PATCH

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