NFnforgeio
user_preferences

Update user preferences.

Omitting a key (theme, homeDashboardId, timezone) will cause the current value to be replaced with the system default value.

put/user/preferences

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/user/preferences
  • Auth
    • HTTP basic
    • or API key in header Authorization

Request body

homeDashboardIdinteger

The numerical :id of a favorited dashboard

homeDashboardUIDstring
languagestring
theme'light' | 'dark' | 'system'
timezone'utc' | 'browser'
weekStartstring

Response

An OKResponse is returned if the request was successful.

messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.