Skip to content

createUserPreferenceValue ​

Create a new "single" value within an existing User Preference record.

Request ​

http
POST /rest/user/preferences/{uPrefId}/value/

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

ParameterTypeRequiredDescription
uPrefIdNumberYesPath variable. The unique id of the user preferences to update. This is the id created during createXYZ API calls.
valueString (max 100 length)YesThe value to be set for the given user preference.

Response ​

200 OK ​

Returns the newly created user preferences with uPrefValueId that can be used for updates/deletes.

RESPONSE:

json
 {
      "uPrefValueId": 291,
      "value": "Whatever",
      "lastModified": 1567662973000
}

Errors ​

ExceptionDescription
WSInvalidParameterExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSUserPreferenceServiceExceptionSee Error Definitions
WSAlreadyExistsExceptionSee Error Definitions