Skip to content

deleteUserPreference ​

Deletes an existing user preference for an authenticated users given a uPrefId used to uniquely identify it.

Request ​

http
DELETE /rest/user/preferences/{uPrefId}

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

PATH VARIABLES: uPrefId (number, required) - the unique id of the user preferences to delete. This is the id created during createXYZ API calls.

Sample call: http://localhost:8080/rest/user/preferences/29

Response ​

200 OK ​

RESPONSE:

json
{
    "errorCode" : 0,
    "errorMsg" : "OK"
}

Errors ​

ExceptionDescription
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSRecordNotFoundExceptionSee Error Definitions
WSUserPreferenceServiceExceptionSee Error Definitions