Create an address

POST /api/v2/addresses

Headers

application/json

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.

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- 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.
- accounts object
  
  The accounts who own the address. This may not be included when viewing all addresses. Refer to the documentation to include this field.
  
  Additional properties are allowed.
- 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.
- lived_in_months integer
  
  The number of months the client lived in the address.

POST /api/v2/addresses

curl \
 -X POST https://api.plannrcrm.com/api/v2/addresses \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"account_uuids":["266fbcc9-764d-4d6e-b7b2-0924a6cf31b1","d1a7161c-1ac1-4d57-874a-6e1f61fed7f3"],"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": [
    "266fbcc9-764d-4d6e-b7b2-0924a6cf31b1",
    "d1a7161c-1ac1-4d57-874a-6e1f61fed7f3"
  ],
  "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": "27aeaaa6-bcc1-4e4e-b60e-8b535da415e4",
  "county": "Hampshire",
  "country": "United Kingdom",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "31887b75-cf6d-4457-ae58-84262048c153",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-01-17T11:18:33+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:33+00: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-01-17T11:18:33+00:00",
  "updated_at": "2025-01-17T11:18:33+00:00",
  "moved_in_year": 2022,
  "moved_in_month": 6,
  "moved_out_year": 2024,
  "lived_in_months": 19,
  "moved_out_month": 1,
  "residential_status": "homeowner",
  "residential_status_other": "homeowner"
}