Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
uuid
integer Required
Body
-
account_uuids
array[string] The UUIDs of the accounts who should own the address. These must only be client accounts.
-
primary_account_uuids
array[string] The UUIDs of the accounts who should have the address as their primary address. These must only be client accounts.
-
name
string The friendly name for the address.
-
address_1
string The first line of the address.
-
address_2
string The second line of the address.
-
address_3
string The third line of the address.
-
address_4
string The fourth line of the address.
-
town_city
string The town or city.
-
county
string The county.
-
postcode
string The postcode.
-
country
string The country.
-
moved_in_month
integer The month the client moved into this address.
-
moved_in_year
integer The year the client moved into this address.
-
moved_out_month
integer The month the client moved out of this address.
-
moved_out_year
integer The year the client moved out of this address.
-
residential_status
string The client's residential status when living at the address.
-
residential_status_other
string 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/uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"account_uuids":["3dd62095-6270-4de8-b3de-4fb11e3e6251","bb18043b-4b5c-4789-8c7f-a954cb4daa45"],"primary_account_uuids":["10361666-268b-46fe-ac43-5c2863f307a0","de67a8d0-a7c1-495c-b46c-68bf953f077e"],"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","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
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"account_uuids": [
"3dd62095-6270-4de8-b3de-4fb11e3e6251",
"bb18043b-4b5c-4789-8c7f-a954cb4daa45"
],
"primary_account_uuids": [
"10361666-268b-46fe-ac43-5c2863f307a0",
"de67a8d0-a7c1-495c-b46c-68bf953f077e"
],
"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",
"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": "889a21d0-0d93-40ed-9c91-6f7bb30c9819",
"county": "Hampshire",
"country": "United Kingdom",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "b41bde3b-51e2-47aa-986e-3a80464b91e6",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-22T13:44:21+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:21+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-04-22T13:44:21+01:00",
"updated_at": "2025-04-22T13:44:21+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": "c9dc219f-5b40-4d13-b11e-87a1968326e8",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-22T13:44:21+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:21+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"residential_status": "homeowner",
"residential_status_other": "homeowner"
}