Update person address
Use case
Here we will review how to update the person address.
Use case data
API parameters with values
Updating the addressId ID-3088of the legal person with personId ID-3397.
...persons/ID-3397/addresses/ID-3088
Sample API call
To update person address, make the following call.
Sample request
Below is an example body request of the API call for updating the person address.
{
"street1": "Brick Lane 4",
"cityCounty": "London",
"zip": "13789",
"countryCode": "GB"
}
curl -L -X PUT 'https://person-api.sandbox.tuumplatform.com/api/v2/persons/ID-3397/addresses/ID-3057' \
-H 'x-channel-code: SYSTEM' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMTJUMTU6MzM6MTAiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODkxNzU5OTB9.qzjD0zt7w5nIvYTaz9xEMP_jfZEgcH6KsnJZdlkdLy8' \
-H 'Content-Type: application/json' \
-d '{
"street1": "Brick Lane 4",
"cityCounty": "London",
"zip": "13789",
"countryCode": "GB"
}'
Sample response
Below you find an example response body to the API call above.
Response
{
"errors": null,
"validationErrors": null,
"data": {
"addressId": "ID-3088",
"personId": "ID-3397",
"addressTypeCode": "R",
"street1": "Brick Lane 4",
"street2": null,
"cityCounty": "London",
"stateRegion": null,
"zip": "13789",
"countryCode": "GB",
"moveInDate": null,
"validityRange": {
"endTime": null,
"startTime": "2023-07-12T14:33:23.624199Z"
}
}
}
Result
The person address information is updated.
