Skip to Content
BlitzPulse docs are live. Looking for Blitz Global? Visit https://blitzglobalcapital.com.
Api ReferenceUser Preferences API

User Preferences API

Auto-generated from openapi-snapshot.json. Do not edit by hand — changes are overwritten by scripts/docs/generate_api_reference.py.

4 endpoints in this group.

GET /api/user-preferences/

Get User Preferences

Return the current user’s preferences, merged over defaults.

Responses

CodeDescription
200Successful Response

PATCH /api/user-preferences/

Patch User Preferences

Deep-merge the provided keys into the user’s JSONB prefs. Returns updated prefs.

Request body: application/json

Responses

CodeDescription
200Successful Response
422Validation Error

GET /api/user/preferences

Get User Preferences Singular

Canonical shell-preference path used by nav/theme settings.

Responses

CodeDescription
200Successful Response

PUT /api/user/preferences

Put User Preferences

Upsert user preferences via PUT for settings screens.

The body remains partial for backwards-compatible preference forms: omitted keys retain their current/default values.

Request body: application/json

Responses

CodeDescription
200Successful Response
422Validation Error