Update an address

PUT /api/v2/addresses/{uuid}

Path parameters

application/json

Body

Responses

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

PUT /api/v2/addresses/{uuid}
curl \
 -X PUT https://api.plannrcrm.com/api/v2/addresses/uuid \
 -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":["5b30f55a-99ef-4b3f-98ad-7e2cb22a4e32","03f32e41-a232-4332-a533-7e43f6931107"],"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","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": [
    "5b30f55a-99ef-4b3f-98ad-7e2cb22a4e32",
    "03f32e41-a232-4332-a533-7e43f6931107"
  ],
  "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",
  "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)
{
  "name": "Work Address",
  "uuid": "1739f8db-e791-4881-8d3d-43acdc87081c",
  "county": "Hampshire",
  "country": "United Kingdom",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "1053260f-340c-462e-bc54-ac89de88b329",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-01-21T09:11:13+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-21T09:11:13+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-21T09:11:13+00:00",
  "updated_at": "2025-01-21T09:11:13+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"
}