Update an address

PUT /api/v1/account/{account_uuid}/address/{uuid}

Headers

Authorization string
Content-Type string
Accept string

Path parameters

account_uuid integer Required
uuid integer Required

application/json

Body

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
primary boolean

Make this address the primary contact address. Will make all other client addresses non primary.

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
  
  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
  
  Address move in date
- accounts object
  
  Accounts that own this address
  
  Additional properties are allowed.

PUT /api/v1/account/{account_uuid}/address/{uuid}

curl \
 -X PUT https://api.plannrcrm.com/api/v1/account/account_uuid/address/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"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","primary":true}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "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",
  "primary": true
}

Response examples (200)

{
  "name": "Work Address",
  "uuid": "58d11027-632c-4336-961d-1b1b025932ac",
  "county": "Hampshire",
  "country": "United Kingdom",
  "accounts": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "34552e58-d723-4588-8850-b345b3f3507a",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:23:59+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:23:59+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-11-20T13:23:59+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:23:59+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:23:59+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:23:59+00:00"
  },
  "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": "2024-11-20T13:23:59+00:00",
  "updated_at": "2024-11-20T13:23:59+00:00",
  "move_in_date": "2023-11-20"
}