v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

Update property

patch/property/{id}

Path parameters

idinteger required

Property ID from Breezeway system

Request body

namestring

Property name

internal_codestring

Property ID from external system

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 property is located in

access_codestring

'Internal access code' field in the UI

guest_access_codestring

Guest access code

wifi_namestring

Name of Wifi Network

wifi_passwordstring

Wifi password

Response

200

namestring

address1string

{"stackTrail":"paths:/property/{id}:patch:responses:200:content:application/json:schema:properties:address2","oasType":"schema","type":"unknown"}

citystring

statestring

zipcodestring

countrystring

groupstring

internal_codestring

latitudenumber

longitudenumber

bedroomsinteger

bathroomsinteger

photosstring[]

buildingstring

wifi_namestring

wifi_passwordstring

access_codestring

Example response

{
  "name": "Shinny Home",
  "address1": "43 Olimpia way",
  "city": "Boston",
  "state": "MA",
  "zipcode": "02215",
  "country": "US",
  "group": "Shinny Star",
  "internal_code": "shinny_home",
  "latitude": 42.3466944,
  "longitude": -71.0971944,
  "bedrooms": 3,
  "bathrooms": 2,
  "photos": [
    "https://test.image.com/flat_11.0.jpg"
  ],
  "building": "Boston 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"
  }
}