Create an address

POST /api/v1/account/{account_uuid}/address

Headers

Authorization string
Content-Type string
Accept string

Path parameters

account_uuid integer Required

application/json

Body Required

name string Required

Name of the address
address_1 string Required

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

Denotes if primary address.

Responses

200 application/json
Hide response attributes Show response attributes object
- 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.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.

POST /api/v1/account/{account_uuid}/address

curl \
 -X POST https://api.plannrcrm.com/api/v1/account/account_uuid/address \
 -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",
  "county": "Hampshire",
  "country": "United Kingdom",
  "primary": true,
  "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-10-16T11:10:13+01:00",
  "updated_at": "2024-10-16T11:10:13+01:00"
}