user-preferences

Update My Preferences

Update the current user's preferences.

Only provided fields will be updated. Omitted fields will retain their current values.

patch/api/v1/auth/preferences

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/auth/preferences
  • Auth: none declared

Headers

Authorizationstring

Request body

theme'light' | 'dark' | 'system'

User preference theme enumeration.

language'en' | 'en' | 'es' | 'es' | 'fr' | 'fr' | 'de' | 'de' | 'ja' | 'ja'

User language enumeration.

timezonestring nullable
date_formatstring nullable
time_formatstring nullable
email_notificationsboolean nullable
email_daily_digestboolean nullable
email_weekly_summaryboolean nullable
email_alert_criticalboolean nullable
email_alert_highboolean nullable
email_alert_mediumboolean nullable
email_alert_lowboolean nullable
notify_onboarding_tipsboolean nullable
notify_usage_alertsboolean nullable
default_dashboard_view'overview' | 'detailed' | 'minimal'

Dashboard view enumeration.

items_per_pageinteger nullable
show_tooltipsboolean nullable
compact_viewboolean nullable
help_level'none' | 'light' | 'heavy'

User help level preference for contextual help system.

Controls how much contextual help is shown in the UI:

  • NONE: No help displayed (power users)
  • LIGHT: Help icons linking to docs (default)
  • HEAVY: Verbose inline explanations (new users, onboarding)
show_cookie_buttonboolean nullable
show_learning_menuboolean nullable
enable_keyboard_shortcutsboolean nullable
auto_refresh_intervalinteger nullable
default_asset_view'list' | 'grid' | 'table'

Asset display mode enumeration.

custom_settingsobject nullable

Response

Successful Response

successboolean required
dataunknown
messagestring nullable
errorstring nullable
metaobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.