General Information
...
Service | API | Method |
---|
urac | /account/changeEmail | POST |
Data Models: Users, Tokens
Workflow: %Link to Architecture Page% Change Email Flow
Input
...
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
---|
uId | Query | YES | String | N/A | User ID |
email | Body | YES | String |
N/AEmail Address Format (JSON Schema Validation) | New Email |
Output
...
Valid Response
Code Block |
---|
language | js |
---|
title | Valid Response Sample |
---|
|
{
"result": true,
"data": "..."
} |
Invalid Response
Code Block |
---|
language | js |
---|
title | Error Response Sample |
---|
|
{
"result":false,
"errors":{
"codes":[405],
"details":[
{
"code":405,
"message":"Unable to find User. Please try again."
}
]
}
} |
Error Codes
| |
---|
405 | Unable to find User. Please try again. |
407 | Problem validating Request. Please try again. |
411 | invalid user id provided |
412 | You have provided the same existing email address |
Example (CURL)
...
Request
Code Block |
---|
language | bash |
---|
title | Calling YOUR Change Email API |
---|
|
> CURL -X POST http://127.0.0.1:4000/urac/account/changeEmail?uId=571a2a0e8cc861b98a0b9467 -d 'email=newemail@domain.com' |
Response
Code Block |
---|
language | js |
---|
title | YOUR Change Email API response |
---|
|
{
"result": true,
"data": "919b0aed-edd8-47d5-ada0-9e5f93cb8249"
} |
...