UserPreferences


GET /user/preferences/{key}

Get a user preference

Read a single user-scoped preference value by key.

Auth: Bearer token required

Path parameters

NameTypeDescription
keystringPreference key

Responses

StatusDescriptionSchema
200OKUserPreference
401UnauthorizedError
403ForbiddenError

PUT /user/preferences/{key}

Set a user preference

Upsert a user-scoped preference value by key (max 64KB once JSON-encoded).

Auth: Bearer token required

Path parameters

NameTypeDescription
keystringPreference key

Request body (application/json)

FieldTypeDescription
valueobject(required)

Responses

StatusDescriptionSchema
200OKUserPreference
401UnauthorizedError
403ForbiddenError

DELETE /user/preferences/{key}

Delete a user preference

Auth: Bearer token required

Path parameters

NameTypeDescription
keystringPreference key

Responses

StatusDescriptionSchema
200OKobject
401UnauthorizedError
403ForbiddenError

Schemas

Error

FieldTypeDescription
errorstring(required)
codestring

UserPreference

FieldTypeDescription
valueobject