Create an address | PlannrCRM API documentation

Create an address Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

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.

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

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
- created_at string
- updated_at string
- name string
- address_1 string
- address_2 string
- address_3 string
- address_4 string
- town_city string
- county string
- postcode string
- country string
- accounts object
  
  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 object
  
  Hide external_references attributes Show external_references attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  third_party
  
  The third party provider with the reference.
  
  reference
  
  The third party reference.
- primary_accounts object
  
  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 object
  
  Hide external_references attributes Show external_references attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  third_party
  
  The third party provider with the reference.
  
  reference
  
  The third party reference.
- moved_in_month integer
- moved_in_year integer
- moved_out_month integer
- moved_out_year integer
- residential_status string
- residential_status_other string
- lived_in_months integer

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":["16989a3c-c10e-43e1-96bf-397f5cd3bf0c","fd33b3c2-1c1c-4a0a-ad6a-3be68855536a","1c67f4ad-bc4f-49a2-a99e-03c9da7d7646"],"primary_account_uuids":["638200ea-c150-4d1d-bf7d-f59d92eacb8d","a50d7783-30a2-4e38-b40b-3e3a13b56bf3","02b72c13-1c46-4d28-bed3-2b13da63ee86"],"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": [
    "16989a3c-c10e-43e1-96bf-397f5cd3bf0c",
    "fd33b3c2-1c1c-4a0a-ad6a-3be68855536a",
    "1c67f4ad-bc4f-49a2-a99e-03c9da7d7646"
  ],
  "primary_account_uuids": [
    "638200ea-c150-4d1d-bf7d-f59d92eacb8d",
    "a50d7783-30a2-4e38-b40b-3e3a13b56bf3",
    "02b72c13-1c46-4d28-bed3-2b13da63ee86"
  ],
  "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)

{
  "uuid": "041d20a0-c5e1-4dfe-b492-ce105db08e27",
  "created_at": "2026-07-20T09:57:25+01:00",
  "updated_at": "2026-07-20T09:57:25+01:00",
  "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",
  "accounts": {
    "uuid": "ceb12d47-96fb-413e-9dc7-bc645832910a",
    "created_at": "2026-07-20T09:57:25+01:00",
    "updated_at": "2026-07-20T09:57:25+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "813b1931-7fef-4422-b11f-7c135dd76d88",
      "created_at": "2026-07-20T09:57:30+01:00",
      "updated_at": "2026-07-20T09:57:30+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "primary_accounts": {
    "uuid": "d0af5c9d-d46e-4f2e-ac42-33a7e62b6298",
    "created_at": "2026-07-20T09:57:25+01:00",
    "updated_at": "2026-07-20T09:57:25+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "813b1931-7fef-4422-b11f-7c135dd76d88",
      "created_at": "2026-07-20T09:57:30+01:00",
      "updated_at": "2026-07-20T09:57:30+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "moved_in_month": 6,
  "moved_in_year": 2022,
  "moved_out_month": 1,
  "moved_out_year": 2024,
  "residential_status": "homeowner",
  "residential_status_other": "homeowner",
  "lived_in_months": 19
}