Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Body
Required
-
account_uuids
array[string] Required The UUIDs of the accounts who should own the address. These must only be client accounts.
-
name
string Required The friendly name for the address.
-
is_primary
boolean When provided and set to true, it will make the created address the primary address for all of the account UUIDs provided.
-
address_1
string Required 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.
POST
/api/v2/addresses
curl \
--request POST 'https://api.plannrcrm.com/api/v2/addresses' \
--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":["840e92d1-4bd1-48b4-b4cf-6cdee2ad1d88","e0030551-3ae1-4d74-91cc-4e9d63e472d7"],"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"}'
Request examples
# 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": [
"840e92d1-4bd1-48b4-b4cf-6cdee2ad1d88",
"e0030551-3ae1-4d74-91cc-4e9d63e472d7"
],
"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"
}
Response examples (201)
{
"name": "Work Address",
"uuid": "9336c6a2-ffe1-490b-ad64-04e759050494",
"county": "Hampshire",
"country": "United Kingdom",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "64736872-9faa-46d2-b6da-9501f5f8bc72",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-02T13:27:59+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:59+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-02T13:27:59+01:00",
"updated_at": "2025-04-02T13:27:59+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": "d8694420-5cee-4846-a6c6-ebcabc55842f",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-02T13:27:59+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:59+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"residential_status": "homeowner",
"residential_status_other": "homeowner"
}