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.

  • The second line of the address.

  • The third line of the address.

  • The fourth line of the address.

  • The town or city.

  • county string

    The county.

  • postcode string

    The postcode.

  • country string

    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.

Responses

  • 201 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • The timestamp of when the resource was created.

    • The timestamp of when the resource was updated.

    • name string

      The friendly name for the address.

    • 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.

    • 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.

    • 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.

    • The number of months the client lived in the address.

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":["1140ec6a-3558-4574-92d0-6de598a368f7","ac8ccbbf-13f4-4d57-9de4-a78d0823080c"],"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": [
    "1140ec6a-3558-4574-92d0-6de598a368f7",
    "ac8ccbbf-13f4-4d57-9de4-a78d0823080c"
  ],
  "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": "7aca0ddf-e7d7-4fdf-8c74-c7a373a7e3ac",
  "county": "Hampshire",
  "country": "United Kingdom",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "41e5a38e-0468-45ef-a249-e2f4080e2537",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-02-20T10:13:06+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-02-20T10:13:06+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-02-20T10:13:06+00:00",
  "updated_at": "2025-02-20T10:13:06+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"
}