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.
-
When provided and set to true, it will make the created address the primary address for all of the account UUIDs provided.
-
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 POST 'https://api.plannrcrm.com/api/v2/addresses' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{
"account_uuids": [
"cb33529f-8756-4ccc-b661-3fecbddcf135",
"e4912a5a-e824-4a0f-88f7-f37dadafa5ad",
"5d995b60-87e2-4554-a5b6-83acbd55f99a"
],
"primary_account_uuids": [
"8a807dbc-9048-4d18-9129-0c2932e33aa7",
"eb1c0c07-727a-4ddb-931f-3856a2da4f18",
"3de91d11-9d10-4324-a08e-1f9002609bd2"
],
"is_primary": true,
"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": [
"cb33529f-8756-4ccc-b661-3fecbddcf135",
"e4912a5a-e824-4a0f-88f7-f37dadafa5ad",
"5d995b60-87e2-4554-a5b6-83acbd55f99a"
],
"primary_account_uuids": [
"8a807dbc-9048-4d18-9129-0c2932e33aa7",
"eb1c0c07-727a-4ddb-931f-3856a2da4f18",
"3de91d11-9d10-4324-a08e-1f9002609bd2"
],
"is_primary": true,
"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": "f64da485-5224-4f93-b3c9-60fa6e9ecce1",
"created_at": "2026-11-18T20:11:45+00:00",
"updated_at": "2026-11-18T20:11:45+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": "2fa8baa9-6a82-4fe3-8dc1-fa1cc0e7c79b",
"created_at": "2026-11-18T20:11:45+00:00",
"updated_at": "2026-11-18T20:11:45+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": "4bcc9b2d-d5f4-4ea4-9e39-edbdbc538591",
"created_at": "2026-11-18T20:11:49+00:00",
"updated_at": "2026-11-18T20:11:49+00:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"primary_accounts": {
"uuid": "bd587252-45d7-4b8b-b5f2-f649aad0033d",
"created_at": "2026-11-18T20:11:45+00:00",
"updated_at": "2026-11-18T20:11:45+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": "4bcc9b2d-d5f4-4ea4-9e39-edbdbc538591",
"created_at": "2026-11-18T20:11:49+00:00",
"updated_at": "2026-11-18T20:11:49+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."
]
}
}