Skip to main content
Version: 4.18.1

Edit Address

Edit Address API will update the address for the requested user.

Resource Informations

Requires authentication?Yes
Rate limited?No


Request headers

AuthorizationBearer token

HTTP request URL

PUT https://{hostname}/auth/realms/{tenantId}/address/{userName}/edit
POST https://{hostname}/auth/realms/{tenantId}/address/{userName}/edit

Digitanium support for this API will be provided on request.


API requests must be made over https. Calls made over plain http will fail.


No parameters fields are required.

Request body(*Required)

Field NameTypeDescription
*addressIDStringDefine the addressID given for a particular address.
lastNameStringlastName of the user.
addressTypeStringDefine the place of the address.

Sample Request

"addressID" : "d5052b76-3a12-4065-a529-f5cf438787e7",
"lastName" : "shaw"
"addressType": "Home"


Field NameTypeDescription
messageStringMessage explains result of the API call. Refer Response status Information for details.
statusStringThe status of the API call. Refer Response status Information for details.
subSystemIntegersubSystem 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 CodeStatusMessage
200OKAddress changed successfully
400BAD_REQUESTMandatory data is missing
401UnauthorizedHTTP 401 Unauthorized
404USER_NOT_FOUNDUser does not exist
404NOT_FOUNDInvalid address