Update Account Preferences

Update the preferences of the currently logged-in account.

Request URL

PUT {base_url}/uc-user/api/v1/preferences/me

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
Body parameters
Parameter Required Type Description
nameDisplayFormat Yes String The format used to display names.

Valid value:

  • fls: First Name Last Name with Space Inbetween
  • lfs: Last Name First Name with Space Inbetween
  • lf: Last Name First Name without Space Inbetween
timeDisplayFormat Yes String The time display format.

Valid value:

  • hh:mm:ss A: 12-hour format.
  • HH:mm:ss: 24-hour format.
dateDisplayFormat Yes String The date display format.

Valid value:

  • yyyy/mm/dd: Year/Month/Day
  • mm/dd/yyyy: Month/Day/Year
  • dd/mm/yyyy: Day/Month/Year
systemLanguage Yes String The system interface language.
Valid value:
  • en: English
  • zh: 简体中文 (Simplified Chinese)
  • pt: Português Brasil (Brazilian Portuguese)
  • it: Italiano (Italian)
  • fr: Français (French)
  • de: Deutsch (German)
  • es: Español (Spanish)
  • el: Ελληνικά (Greek)

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Preferences> The preferences of the current user.
Preferences
Parameter Type Description
nameDisplayFormat String The format used to display names.
  • fls: First Name Last Name with Space Inbetween
  • lfs: Last Name First Name with Space Inbetween
  • lf: Last Name First Name without Space Inbetween
dateDisplayFormat String The date display format.
  • yyyy/mm/dd: Year/Month/Day
  • mm/dd/yyyy: Month/Day/Year
  • dd/mm/yyyy: Day/Month/Year
timeDisplayFormat String The time display format.
  • hh:mm:ss A: 12-hour format.
  • HH:mm:ss: 24-hour format.
systemLanguage String The web interface language.

Example

Request example

PUT /uc-user/api/v1/preferences/me HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc0ODc3OCwiaWF0IjoxNzkwNzI3MTc4LCJqdGkiOiJlZTQwMmQzNC03YjQ5LTQ4YmUtYWM0Yi02NDMyMDkzZDBhZDQiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.mq9d6uoAWxFZ4LJQSdWtSfp3jWK2-5-Nq-YJqA2p5qyN7ClRmxrZdeA9WolJsO7ONIKZfhqfjEYyCZeepU5iYJvShEJX2XlGrSfu9bkX8bO9byMq9pH_fxHmAyVnfu1R6Uy9c4YvQS6QW5iZmnTOjnV7Tzp0HarGi-D6rIzRYhm87ctWoNwtrDrFjB6WxZl-la1_NIOx9_LLlvewB-xoSxJRxXC7xOP-Xy5GC7amqytS8nplu0GwqmHu8PxEkJ3LeDWrSPqkLQqULdyzfsC0e2iJthEvLX7STMH7jSvLnjw7TH7cBLPsg-NdurAZ31TC3H5q4oKGKL0WBAJmrnAcQg
Content-Type: application/json
{
  "nameDisplayFormat": "lfs",
  "dateDisplayFormat": "mm/dd/yyyy",
  "timeDisplayFormat": "hh:mm:ss A",
  "systemLanguage": "zh"
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "nameDisplayFormat": "lfs",
    "dateDisplayFormat": "mm/dd/yyyy",
    "timeDisplayFormat": "hh:mm:ss A",
    "systemLanguage": "zh"
  },
  "requestId": "5efa23bc050ed13898f340a6fc610c30",
  "code": "200",
  "message": "SUCCESS"
}