Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

ServiceAPIMethod
urac/account/changeEmailPOST


Data Model: %Link to Data Model%Models: UsersTokens

Workflow: %Link to Architecture Page%

...

  
NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/AUser ID
emailBodyYESStringN/ANew Email

 

Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": { 		"..."	
	}
}

 

Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[400405],
        "details":[
            {
                "code":400405,
                "message":"Problem with the provided passwordUnable to find User. Please try again."
            }
        ]
    }
}



Error Codes


 

Database Error
Code
Description
400
405Unable to find User. Please try again.
407Problem validating Request. Please try again.
411invalid user id provided
412You have provided the same existing email address


Example (CURL)

...

Request

Code Block
languagebash
titleCalling YOUR API
 > CURL -X POST http://127.0.0.1:4000/urac/account/...changeEmail?uId=571a2a0e8cc861b98a0b9467 -d 'email=newemail@domain.com

Response

Code Block
languagejs
titleYOUR API response
{
	"result": true,
	"data": { 		"_id": "57063608622c47b5c097d19b",
		"..."
	}"919b0aed-edd8-47d5-ada0-9e5f93cb8249"
}