Documentation Center

Update profile preferences

Update your WorldServer profile preferences.

For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The sessionId in the response is your session token. Use this token in all the other calls that you make.

Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v1/users/me/profilePreferences?token=<sessionId>&key=<key>&value=<newValue>

Details

  • PUT method
  • Content-Type in the header: application/json
  • Mandatory parameters: the session token (as a query string parameter or as a key-value pair in the header), the key (as a query string parameter), and the value (as a query string parameter)

Request example

A screen shot that shows a possible request body for this call.

Response

A screen shot that shows a typical response to this call.

Error messages

No session token provided or invalid token (401 Unauthorized)