Update an address | PlannrCRM API documentation

Update 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"
  }
}

PUT /api/v2/addresses/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required

application/json

Body

account_uuids array[string(uuid)]

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

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

PUT /api/v2/addresses/{uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v2/addresses/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"account_uuids":["4c68d1f1-1354-4050-bb8a-317b81184d94","dfa7363a-5578-4975-9e7e-f0795122404b","0b48f100-7287-4715-9838-d1b5a9a680ca"],"primary_account_uuids":["beacfc12-27b0-434c-a315-b074ca561633","9d95571c-cc3c-46e3-bd79-63dfa9b13e4c","b91b2fbe-f0db-4acc-949d-5bae6789ec32"],"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": [
    "4c68d1f1-1354-4050-bb8a-317b81184d94",
    "dfa7363a-5578-4975-9e7e-f0795122404b",
    "0b48f100-7287-4715-9838-d1b5a9a680ca"
  ],
  "primary_account_uuids": [
    "beacfc12-27b0-434c-a315-b074ca561633",
    "9d95571c-cc3c-46e3-bd79-63dfa9b13e4c",
    "b91b2fbe-f0db-4acc-949d-5bae6789ec32"
  ],
  "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 (200)

{
  "uuid": "cb9651a6-0005-4994-b26c-5fb72b9c2dc5",
  "created_at": "2026-06-27T09:33:42+01:00",
  "updated_at": "2026-06-27T09:33:42+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": "3cdd698b-13a2-49da-be26-9a277ad161f0",
    "created_at": "2026-06-27T09:33:42+01:00",
    "updated_at": "2026-06-27T09:33:42+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": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "primary_accounts": {
    "uuid": "9eb206e6-b5e7-4266-826a-6123bf3a19fd",
    "created_at": "2026-06-27T09:33:42+01:00",
    "updated_at": "2026-06-27T09:33:42+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": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "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
}