Update preference setting - Cloudreve API Docs

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params application/json

nick

string | null

optional

Display name.

>= 1 characters<= 255 characters

Example:

Aaron Liu

group_expires

boolean | null

optional

Set this to true to manually cancel membership before expiration. Only appliable to Pro edition.

language

string | null

optional

Preferred UI and Email language.

Example:

zh-CN

preferred_theme

string | null

optional

Set preferred theme color. Available options can be get from Get site settings.

Example:

#1976d2

version_retention_enabled

boolean | null

optional

Whether file version retention is enabled.

version_retention_ext

array[string] | null

optional

List of file extensions enabling file version retention. For null or empty list, all extensions are enabled.

version_retention_max

integer | null

optional

Max preserved version. For value 0, all version will be preserved.

current_password

string | null

optional

Current user password, required for updating password.

new_password

string | null

optional

New password. If set, current_password is required.

>= 6 characters<= 128 characters

two_fa_enabled

boolean | null

optional

Whether 2FA is enabled.

two_fa_code

string | null

optional

Required if two_fa_enabled is not null.

If two_fa_enabled is true, this is the 6-digts code for the new 2FA secret.
If two_fa_enabledisfalse`, this is the 6-digts code for current enabled secret.

disable_view_sync

boolean | null

optional

Whether explorer view setting sync is disabled.

Example

{
    "nick": "Aaron Liu",
    "group_expires": true,
    "language": "zh-CN",
    "preferred_theme": "#1976d2",
    "version_retention_enabled": true,
    "version_retention_ext": [
        "string"
    ],
    "version_retention_max": 0,
    "current_password": "string",
    "new_password": "string",
    "two_fa_enabled": true,
    "two_fa_code": "string",
    "disable_view_sync": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH '/user/setting' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nick": "Aaron Liu",
    "group_expires": true,
    "language": "zh-CN",
    "preferred_theme": "#1976d2",
    "version_retention_enabled": true,
    "version_retention_ext": [
        "string"
    ],
    "version_retention_max": 0,
    "current_password": "string",
    "new_password": "string",
    "two_fa_enabled": true,
    "two_fa_code": "string",
    "disable_view_sync": true
}'

Responses

🟢200Success

application/json

Body

code

integer

required

Response code.
0 - Success.

Default:

0

Example:

0

msg

string

optional

Human readable error message (if any).

error

string | null

optional

Internal error message, only visable in debug mode.

correlation_id

string <uuid> | null

optional

Correlation ID of the request. Only presented on failed reqeust.

Example:

b4351ecc-ee1a-4455-bc94-2c3dbcc58538

Example

{
    "code": 0,
    "msg": ""
}