Sign in

v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

Create/update property

post/property/external-id/{id}

Path parameters

idstring required

Property ID from external system

Request body

reference_company_idstring

Company ID from external system; required if using cross-company access

namestring

Property name

address1string

Address, line 1

address2string

Address, line 2

citystring

Property city

statestring

Property state

zipcodestring

Property zip/postal code

countrystring

Property country

latitudenumber float

Property latitude

longitudenumber float

Property longitude

photosstring[]

List of URLs to property photos. Breezeway will download photos from these URLs

status'active' | 'inactive' | 'deleted'
buildingstring

Building unit is contained within

bedroomsinteger

Number of property bedrooms **Bedroom count can be set only when property is created, it does not allow updating the count.

bathroomsinteger

Number of property bathrooms, rounded to nearest integer. **Bathroom count can be set only when property is created, it does not allow updating the count.

access_codestring

Property access code

guest_access_codestring

Guest access code

wifi_namestring

Name of Wifi Network

wifi_passwordstring

Wifi password

Response

200

namestring
address1string
{"stackTrail":"paths:/property/external-id/{id}:post:responses:200:content:application/json:schema:properties:address2","oasType":"schema","type":"unknown"}
citystring
statestring
zipcodestring
countrystring
groupstring
latitudenumber
longitudenumber
bedroomsinteger
bathroomsinteger
photosstring[]
buildingstring
wifi_namestring
wifi_passwordstring
access_codestring

Example response

{
  "name": "Fenway Park",
  "address1": "4 Yawkey Way",
  "city": "Boston",
  "state": "MA",
  "zipcode": "02215",
  "country": "US",
  "group": "group A",
  "latitude": 42.3466944,
  "longitude": -71.0971944,
  "bedrooms": 3,
  "bathrooms": 2,
  "photos": [
    "https://test.image.com/flat_11.0.jpg"
  ],
  "building": "Maple St. Apartments",
  "wifi_name": "6D_WayFen",
  "wifi_password": "WayWayPassw0rd",
  "access_code": "1234",
  "notes": {
    "access": "access note",
    "general": "general public note",
    "wifi": "wifi note",
    "about": "Near railway station, this property offers great connection with the rest of the state",
    "direction": "Near railway station",
    "trash_info": "Every Tuesday ay 6am"
  }
}