Update an address Run in API Explorer
Body
-
The UUIDs of the accounts who should own the address. These must only be client accounts.
-
The UUIDs of the accounts who should have the address as their primary address.
-
Name of the address
-
First line of the address
-
Second line of the address
-
Third line of the address
-
Fourth line of the address
-
Town/City
-
County
-
Postcode
-
Country
-
Move in date
-
The month the client moved into this address.
-
The year the client moved into this address.
-
The month the client moved out of this address.
-
The year the client moved out of this address.
-
The client's residential status when living at the address.
Value Description homeowner Homeowner renting Renting living_with_parents Living With Parents other Other Values are
homeowner,renting,living_with_parents, orother. -
The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other.
curl \
--request PUT 'https://api.plannrcrm.com/api/v2/addresses/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{
"account_uuids": [
"81f4a99a-2430-406e-91bf-f08e09fdcbc5",
"ead2881a-5789-4b01-b050-cdfe9910d441",
"74a2116b-d8ee-4112-be16-dd08b6466e12"
],
"primary_account_uuids": [
"8f5ed596-975e-4e27-82cc-65fc62cb97c6",
"eb734566-96a4-4211-82e3-925e5dec2364",
"c68c05a5-c262-46d9-9b38-4ef7de4fc3e5"
],
"name": "Work Address",
"address_1": "Suite E",
"address_2": "5 The Briars",
"address_3": "Waterberry Drive",
"address_4": "The Innovative Centre",
"town_city": "Waterlooville",
"county": "Hampshire",
"postcode": "PO7 7YH",
"country": "United Kingdom",
"move_in_date": "2024-06-20",
"moved_in_month": 6,
"moved_in_year": 2022,
"moved_out_month": 1,
"moved_out_year": 2024,
"residential_status": "homeowner",
"residential_status_other": "Non-tenant occupier"
}'
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"account_uuids": [
"81f4a99a-2430-406e-91bf-f08e09fdcbc5",
"ead2881a-5789-4b01-b050-cdfe9910d441",
"74a2116b-d8ee-4112-be16-dd08b6466e12"
],
"primary_account_uuids": [
"8f5ed596-975e-4e27-82cc-65fc62cb97c6",
"eb734566-96a4-4211-82e3-925e5dec2364",
"c68c05a5-c262-46d9-9b38-4ef7de4fc3e5"
],
"name": "Work Address",
"address_1": "Suite E",
"address_2": "5 The Briars",
"address_3": "Waterberry Drive",
"address_4": "The Innovative Centre",
"town_city": "Waterlooville",
"county": "Hampshire",
"postcode": "PO7 7YH",
"country": "United Kingdom",
"move_in_date": "2024-06-20",
"moved_in_month": 6,
"moved_in_year": 2022,
"moved_out_month": 1,
"moved_out_year": 2024,
"residential_status": "homeowner",
"residential_status_other": "Non-tenant occupier"
}
{
"uuid": "c9368fe3-5078-4da5-95be-d0f22275eed9",
"created_at": "2026-11-16T13:00:53+00:00",
"updated_at": "2026-11-16T13:00:53+00:00",
"name": "Work Address",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"address_3": "The Innovative Centre",
"address_4": "Waterlooville",
"town_city": "Waterlooville",
"county": "Hampshire",
"postcode": "PO7 7YH",
"country": "United Kingdom",
"accounts": {
"uuid": "20b6216d-3eb0-4b63-b651-699cd1fc8d3d",
"created_at": "2026-11-16T13:00:53+00:00",
"updated_at": "2026-11-16T13:00:53+00:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"external_references": {
"uuid": "da4de829-57ae-478a-bf37-1414f7626c4f",
"created_at": "2026-11-16T13:00:59+00:00",
"updated_at": "2026-11-16T13:00:59+00:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"primary_accounts": {
"uuid": "e91b8b85-4636-4eec-b132-1d5521910529",
"created_at": "2026-11-16T13:00:53+00:00",
"updated_at": "2026-11-16T13:00:53+00:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"external_references": {
"uuid": "da4de829-57ae-478a-bf37-1414f7626c4f",
"created_at": "2026-11-16T13:00:59+00:00",
"updated_at": "2026-11-16T13:00:59+00:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"moved_in_month": 6,
"moved_in_year": 2022,
"moved_out_month": 1,
"moved_out_year": 2024,
"residential_status": "homeowner",
"residential_status_other": "homeowner",
"lived_in_months": 19
}
{
"message": "The given data was invalid.",
"errors": {
"field": [
"The field is invalid."
]
}
}