persons/{uid}/settings (PUT)

This method lets you update specific user interface preferences of yourself or a specific person.

The properties you can update are, among others, user interface language, user interface “culture” or date/time format and the time zone.

URL

CODE

(PUT) /api/persons/{uid}/settings
(PUT) /api/persons/me/settings

The URL parameters are:

uid

Either pass a user ID or the shortcut “me” for the logged user.

To find users, see persons/list

int or “me”, Mandatory

The body must contain a JSON object with these properties:

language

Optional.

If null or missing then no change will be done.

To change the user interface language. For example:

CODE

"language": "fr"

To get all available options check out the “includeOptions” property in method persons/{uid}/settings

string?, Optional

culture

Optional.

If null or missing then no change will be done.

To change the date time format (culture) to a specific region. For example:

CODE

"culture": "fr-FR"

To get all available options check out the “includeOptions” property in method persons/{uid}/settings

string?, Optional

timezone

Optional.

If null or missing then no change will be done.

To change the time zone. For example:

CODE

"timezone": "Romance Daylight Time"

To get all available options check out the “includeOptions” property in method persons/{uid}/settings

string?, Optional

The method simply returns the updated properties, see results of Person settings