---
title: "Create/update property"
method: POST
path: "/property/external-id/{id}"
---

# Create/update property

`POST /property/external-id/{id}`

## Request

- Base URL: `https://api.breezeway.io/public/inventory/v1`
- URL: `https://api.breezeway.io/public/inventory/v1/property/external-id/{id}`
- Auth: API key in header `Authorization`

## Path parameters

- `id` string, required

## Request body

- object
  - `reference_company_id` string: Company ID from external system; required if using cross-company access
  - `name` string: Property name
  - `address1` string: Address, line 1
  - `address2` string: Address, line 2
  - `city` string: Property city
  - `state` string: Property state
  - `zipcode` string: Property zip/postal code
  - `country` string: Property country
  - `latitude` number, float: Property latitude
  - `longitude` number, float: Property longitude
  - `photos` string[]: List of URLs to property photos. Breezeway will download photos from these URLs
  - `status` 'active' | 'inactive' | 'deleted'
  - `building` string: Building unit is contained within
  - `notes` object: Property notes
    - `wifi` string: Property wifi note
    - `access` string: Property internal access note. 'Internal access notes' in the UI
    - `general` string: Property general note. 'Property notes' in the UI
    - `direction` string: Property direction note
    - `about` string: Property "about" section note. 'About Property' in the UI
    - `trash_info` string: Property trash info note
    - `guest_access` string: Property guest access note. 'Guest access notes' in the UI
  - `bedrooms` integer: Number of property bedrooms **Bedroom count can be set only when property is created, it does not allow updating the count.
  - `bathrooms` integer: 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_code` string: Property access code
  - `guest_access_code` string: Guest access code
  - `wifi_name` string: Name of Wifi Network
  - `wifi_password` string: Wifi password

## Response `200`

200

- object
  - `name` string
  - `address1` string
  - `address2` unknown
  - `city` string
  - `state` string
  - `zipcode` string
  - `country` string
  - `group` string
  - `latitude` number
  - `longitude` number
  - `bedrooms` integer
  - `bathrooms` integer
  - `photos` string[]
  - `building` string
  - `wifi_name` string
  - `wifi_password` string
  - `access_code` string
  - `notes` object
    - `access` string
    - `general` string
    - `wifi` string
    - `about` string
    - `direction` string
    - `trash_info` string

## Other responses

- `422`: 422

---

[API](https://skmtc.dev/breezeway/apis/breezeway-api.md) - [All operations](https://skmtc.dev/breezeway/apis/breezeway-api/llms.txt) - [OpenAPI document](https://skmtc.dev/breezeway/apis/breezeway-api/revisions/557cdcedc1ac?raw)
