POST /api/v2/addresses
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • account_uuids array[string(uuid)] Required

    The UUIDs of the accounts who should own the address. These must only be client accounts.

  • primary_account_uuids array[string(uuid)]

    The UUIDs of the accounts who should have the address as their primary 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.

  • name string

    Name of the address

  • address_1 string

    First line of the address

  • address_2 string

    Second line of the address

  • address_3 string

    Third line of the address

  • address_4 string

    Fourth line of the address

  • town_city string

    Town/City

  • county string

    County

  • postcode string

    Postcode

  • country string

    Country

  • move_in_date string

    Move in date

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

    Value Description
    homeowner Homeowner
    renting Renting
    living_with_parents Living With Parents
    other Other

    Values are homeowner, renting, living_with_parents, or other.

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

      Hide accounts attributes Show accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references string
    • primary_accounts object

      The accounts who own the address and have it as their primary address. This may not be included when viewing all addresses. Refer to the documentation to include this field.

      Hide primary_accounts attributes Show primary_accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references string
    • 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 \
 --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":["09edf5bd-28e3-4915-8378-81a503041cd4","b1811d7d-d56c-4873-a293-996d7721c3b2","15baa7f5-6fdc-4d94-b996-ce5f0ded8ca6"],"primary_account_uuids":["248a569a-2193-463b-bd7d-fee9acb573ed","267df64c-efe8-4756-a6a6-abe212776e2c","2cdbf061-fee8-4e10-bc52-d5ec0cc2fc6e"],"is_primary":true,"name":"Work Address","address_1":"Suite E","address_2":"5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","move_in_date":"2024-06-20","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
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuids": [
    "09edf5bd-28e3-4915-8378-81a503041cd4",
    "b1811d7d-d56c-4873-a293-996d7721c3b2",
    "15baa7f5-6fdc-4d94-b996-ce5f0ded8ca6"
  ],
  "primary_account_uuids": [
    "248a569a-2193-463b-bd7d-fee9acb573ed",
    "267df64c-efe8-4756-a6a6-abe212776e2c",
    "2cdbf061-fee8-4e10-bc52-d5ec0cc2fc6e"
  ],
  "is_primary": true,
  "name": "Work Address",
  "address_1": "Suite E",
  "address_2": "5 The Briars",
  "address_3": "Waterberry Drive",
  "address_4": "The Innovative Centre",
  "town_city": "Waterlooville",
  "county": "Hampshire",
  "postcode": "PO7 7YH",
  "country": "United Kingdom",
  "move_in_date": "2024-06-20",
  "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": "18e44417-dd83-4d54-8025-24d8aae5bfef",
  "county": "Hampshire",
  "country": "United Kingdom",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "362cc850-6080-40b1-87ca-500dd564a1bc",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2026-02-26T15:22:28+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-02-26T15:22:28+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": "2026-02-26T15:22:28+00:00",
  "updated_at": "2026-02-26T15:22:28+00: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": "f8e83e36-c25d-47a4-b823-e5d998e2a924",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2026-02-26T15:22:28+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-02-26T15:22:28+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "residential_status": "homeowner",
  "residential_status_other": "homeowner"
}