Skip to content

updateMe

PATCH
/me
curl --request PATCH \
  --url http://localhost:8080/api/v1/me \
  --header 'Content-Type: application/json' \
  --cookie hs_session=<hs_session> \
  --data '{ "displayName": "example", "locale": "en", "theme": "system", "textScale": 1, "reducedMotion": true, "shareVisits": true, "showAiSummaries": true, "currentPassword": "example", "newPassword": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
displayName
string
>= 1 characters <= 60 characters
locale
One of:
string
Allowed values: en zh-Hans th
theme
string
Allowed values: system light dark
textScale
number
>= 1 <= 1.6
reducedMotion
boolean
shareVisits
boolean
showAiSummaries
boolean
currentPassword
string
newPassword
string
>= 8 characters <= 200 characters

Responses

Section titled “Responses”

200

Section titled “200”

Updated.

Media typeapplication/json
object
member
required
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
username
required
string
displayName
required
string
role
required
string
Allowed values: owner member viewer
locale
One of:
string
Allowed values: en zh-Hans th
theme
required
string
Allowed values: system light dark
textScale
required
number
>= 1 <= 1.6
reducedMotion
required
boolean
shareVisits
boolean
showAiSummaries
boolean
avatar
One of:
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
url
required

Signed URL, valid 24 h.

string
thumbUrl
string
cardUrl
string
posterUrl
string
mime
required
string
width
integer
height
integer
durationMs
integer
blurhash
string
alt
string
createdAt
required
string format: date-time
lastSeenAt
One of:
string format: date-time
household
required
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
name
required
string
defaultLocale
required
string
Allowed values: en zh-Hans th
memberCount
required
integer
baseUrl
required
string format: uri
createdAt
required
string format: date-time
effectiveLocale
required
string
Allowed values: en zh-Hans th
csrfToken
string

Examples

Exampleseed

Derived from fixtures/seed.json.

{
  "csrfToken": "csrf_demoWebToken0123456789abcdef",
  "effectiveLocale": "en",
  "household": {
    "baseUrl": "http://localhost:5173",
    "createdAt": "2026-09-17T09:00:00.000Z",
    "defaultLocale": "th",
    "id": "hh_01j9vd2c703tt6a613pxhc9s0s",
    "memberCount": 3,
    "name": "The Wongs' Homestead"
  },
  "member": {
    "avatar": null,
    "createdAt": "2026-09-17T09:00:00.000Z",
    "displayName": "Mali",
    "id": "mem_01j9kt0d8rwgmhnmxkmv0frnr0",
    "lastSeenAt": null,
    "locale": "en",
    "reducedMotion": false,
    "role": "owner",
    "shareVisits": true,
    "showAiSummaries": true,
    "textScale": 1,
    "theme": "system",
    "username": "mali"
  }
}

400

Section titled “400”

Invalid request.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
code
required
string
i18nKey
string
detail
string
fields
Array<object>
object
path
required
string
code
required
string
i18nKey
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "i18nKey": "example",
  "detail": "example",
  "fields": [
    {
      "path": "example",
      "code": "example",
      "i18nKey": "example"
    }
  ]
}