CreatePropertyRequest

Request model for creating a new property.

name
Type: string
min length:
1
max length:
200
required

Property name. Required, 1-200 characters.
avgContractLengthYears
Type: null | number | stringFormat: double

Average contract length in years.
categories
Type:

Asset categories with yield, rental income, rented/vacant area data.

Properties: 7
description
Type: null | string

Property description.
externalRefs
Type: …10

External references for CRM integration (e.g., Yardi, Salesforce). Each namespace can only appear once. Maximum 10 refs.

Properties: 2
location
Type: nullable

Location data: latitude, longitude, country (ISO 3166-1 alpha-2), locality.

Properties: 4
operatingCosts
Type: nullable

Annual operating costs.

Properties: 3
parcelArea
Type: nullable

Parcel area. Write requests must include unit "sqm".

Properties: 2
price
Type: nullable

Investment price.

Properties: 3
tags
Type: null | array of string

Property tags using the documented snake_case values.
tenure
Type: null | string

Tenure: freehold or leasehold.
yearBuilt
Type: null | integer | stringFormat: int32

Year the property was built.
zoning
Type: nullable

Zoning information: permitted GFA and zoning categories.

Properties: 2