Skip to content

changePassword ​

Changes an existing user's password given a valid existing password and new passwords.

Request ​

http
POST /rest/user/password

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

A JSON request in format below. All fields mandatory. Only version 1 supported as of 2016-07-12.

json
{
  "version": 1,
  "existingPassword": "pa55word",
  "newPassword": "changedPassword",
  "newPasswordConfirm": "changedPassword",
  "uEmail": "aaron.mcmullen@hypermedia.com.au",
  "appCode": "MY"
}

Response ​

200 OK ​

JSON response:

json
{
"errorCode": 0,
"errorMsg": "User password change successful."
}

Errors ​

ExceptionDescription
WSUserServiceUnavailableExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSEmailNotFoundExceptionSee Error Definitions
WSUserInvalidPasswordExceptionSee Error Definitions
WSPasswordMismatchExceptionSee Error Definitions
WSPasswordLengthExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSUserServiceExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInvalidPasswordResetExceptionSee Error Definitions