Skip to content
WorkRoad home
REST API

Update the profile

PATCH
/settings/profile

Changes the name, username, bio, status, location or what the public profile shows. The sign-in email address can't be changed here.

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.

name?string

2 to 100 characters.

Length2 <= length <= 100
username?string

3 to 30 letters, digits, _ or ., stored in lower case. Fails with 409 when another account has it.

Match^[a-zA-Z0-9_.]+$
Length3 <= length <= 30
description?string

Up to 512 characters. Send an empty string to clear it.

Length0 <= length <= 512
status?string

Up to 256 characters. Send an empty string to clear it.

Length0 <= length <= 256
location?string

Up to 256 characters. Send an empty string to clear it.

Length0 <= length <= 256
showLastLogin?boolean
showCreated?boolean
showTimezone?boolean
showMembership?boolean

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://workroad.app/api/v1/settings/profile' \  -H 'Authorization: Bearer $WORKROAD_API_KEY' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "name": "Ada Lovelace",    "username": "ada",    "description": "Maths and computing, mostly.",    "status": "Revising for finals",    "location": "London",    "showLastLogin": true,    "showCreated": true,    "showTimezone": false,    "showMembership": true  }}

Update language, time zone or privacy PATCH

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.

Update review settings PATCH

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