General Information
...
| Name | Source | Mandatory | Type | Special Format | Description | |
|---|---|---|---|---|---|---|
| uId | Query | YES | String | N/A | ||
| username | Body | YES | String | alphanumeric with _ , - characters only | ||
| firstName | Body | YES | String | N/A | ||
| lastName | Body | YES | String | N/A | ||
| profile | Body | NO | String | N/A | a stringified object. |
...
Output
...
Valid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result": true,
"data": true
} |
...
Invalid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result":false,
"errors":{
"codes":[405],
"details":[
{
"code":405,
"message":"Unable to find User. Please try again."
}
]
}
} |
Error Codes
Code | Description | |||
|---|---|---|---|---|
| 405 | Unable to find User. Please try again. | |||
| 407 | Problem validating Request. Please try again. | |||
| 410 | username taken, please choose another username | |||
| 411 | invalid user id provided | 413 | Invalid profile fieldprovided | . Profile should be a stringified object.|
| 415 | Unable to find group. | |||
| 500 | This record in locked. You cannot modify or delete it |
Example (CURL)
...