Body
Required
-
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.
-
The friendly name for the address.
-
When provided and set to true, it will make the created address the primary address for all of the account UUIDs provided.
-
The first line of the address.
-
The second line of the address.
-
The third line of the address.
-
The fourth line of the address.
-
The town or city.
-
The county.
-
The postcode.
-
The country.
-
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.
-
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":["de08bdf0-079a-4b0f-a659-ec10768c09d9","cdd4d90b-1371-4856-906d-0ebb6c397c41"],"primary_account_uuids":["e074c702-a455-4ebe-a85c-47808292b462","2aa7c3ab-a083-4aff-8a85-e32ef817d682"],"name":"Work Address","is_primary":true,"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","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": [
"de08bdf0-079a-4b0f-a659-ec10768c09d9",
"cdd4d90b-1371-4856-906d-0ebb6c397c41"
],
"primary_account_uuids": [
"e074c702-a455-4ebe-a85c-47808292b462",
"2aa7c3ab-a083-4aff-8a85-e32ef817d682"
],
"name": "Work Address",
"is_primary": true,
"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",
"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"
}
{
"name": "Work Address",
"uuid": "725695c6-bf4d-46c6-8e8a-95ce61c69606",
"county": "Hampshire",
"country": "United Kingdom",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "994baa9c-43b6-4595-9339-a164489c3bfc",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-07T13:41:47+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:47+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"address_3": "The Innovative Centre",
"address_4": "Waterlooville",
"town_city": "Waterlooville",
"created_at": "2025-08-07T13:41:47+01:00",
"updated_at": "2025-08-07T13:41:47+01:00",
"moved_in_year": 2022,
"moved_in_month": 6,
"moved_out_year": 2024,
"lived_in_months": 19,
"moved_out_month": 1,
"primary_accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "ba2160fb-3731-4653-aea0-faaadaccfed3",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-07T13:41:47+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:47+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"residential_status": "homeowner",
"residential_status_other": "homeowner"
}