Edit Address
Edit Address API will update the address for the requested user.
Resource Informations
Name | Value |
---|---|
Requires authentication? | Yes |
Rate limited? | No |
Request
Request headers
Key | Value |
---|---|
Authorization | Bearer token |
Content-Type | application/json |
HTTP request URL
PUT https://{hostname}/auth/realms/{tenantId}/address/{userName}/edit
POST https://{hostname}/auth/realms/{tenantId}/address/{userName}/edit
note
Digitanium support for this API will be provided on request.
note
API requests must be made over https. Calls made over plain http will fail.
Parameters
No parameters fields are required.
Request body(*Required)
Field Name | Type | Description |
---|---|---|
*addressID | String | Define the addressID given for a particular address. |
lastName | String | lastName of the user. |
addressType | String | Define the place of the address. |
Sample Request
{
"addressID" : "d5052b76-3a12-4065-a529-f5cf438787e7",
"lastName" : "shaw"
"addressType": "Home"
}
Response
Field Name | Type | Description |
---|---|---|
message | String | Message explains result of the API call. Refer Response status Information for details. |
status | String | The status of the API call. Refer Response status Information for details. |
subSystem | Integer | subSystem categorizes the type of API that has been called. Refer Subsystem details for details. |
Sample Response
{
"message": "Address changed successfully",
"status": "Success",
"subSystem": 5
}
Response Status Information
Status Code | Status | Message |
---|---|---|
200 | OK | Address changed successfully |
400 | BAD_REQUEST | Mandatory data is missing |
401 | Unauthorized | HTTP 401 Unauthorized |
404 | USER_NOT_FOUND | User does not exist |
404 | NOT_FOUND | Invalid address |