Partially update user preferences

PATCH

/api/user/preferences

curl --request PATCH \
  --url https://example.com/api/user/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "view": { "defaultView": "grid" } }'

• CM Box Server

Merges the supplied fields into the current user’s existing preferences, leaving other fields unchanged.

Authorizations

• bearerAuth

Request Body

Media typeapplication/json

object

view

required

object

defaultView

required

Default view mode

string

Allowed values: grid list

Example

grid

tableColumns

Saved table column selections

Array<string>

recentRepositories

Recently visited repositories

Array<object>

<= 3 items

object

CACHE_ROOT

required

Repository namespace

string

Example

my-repo

name

Display name

string

lastVisited

required

Timestamp of last visit

number

recentSites

Recently visited sites

Array<object>

<= 3 items

object

id

required

Site ID

string

name

Site name

string

lastVisited

required

Timestamp of last visit

number

detailPaneColumns

Number of grid columns visible when detail pane is open

number

default: 2 >= 1 <= 5

Example

2

theme

UI theme mode

string

default: dark

Allowed values: dark light

Example

dark

uiVersion

UI version preference

string

default: content2

Allowed values: content content2

Example

content2

Responses

200

Preferences updated successfully

Media typeapplication/json

object

success

required

Whether the update was successful

boolean

preferences

Updated user preferences

object

key

additional properties

Example^generated

{
  "success": true,
  "preferences": {
    "additionalProperty": "example"
  }
}

401

Not authenticated

Media typeapplication/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}