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 | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

Average contract length in years.
categories
Type: array object[] | null · CreatePropertyCategoryRequest[]

Asset categories with yield, rental income, rented/vacant area data.
Category data for property creation.
- type
  Type: string
  required
  
  Asset type with optional sub-type: "office", "retail/shopping_mall", etc.
- conversions
  Type: array string[] | null
- locationClass
  Type: null | string
- rentalIncome
  Type: object · Price nullable
  
  Single price value for public API (e.g., asking price, transaction price).
- rentedArea
  Type: object · Area nullable
  
  Area measurement with value and unit.
- vacantArea
  Type: object · Area nullable
  
  Area measurement with value and unit.
- yieldPercent
  Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
description
Type: null | string

Property description.
externalRefs
Type: array object[] | null · ExternalRef[] …10

External references for CRM integration (e.g., Yardi, Salesforce). Each namespace can only appear once. Maximum 10 refs.
Represents an external system reference (e.g., Salesforce, HubSpot, Pipedrive). Supports multiple CRM systems simultaneously.
- id
  Type: string
  max length:
  255
  required
  
  External identifier within the namespace (e.g., "003XXXXXXXXXXXX" for Salesforce). Case-sensitive. Format depends on the external system.
- namespace
  Type: string
  max length:
  50
  required
  
  External system namespace (e.g., "salesforce", "hubspot", "pipedrive", "csv-import"). Case-insensitive.
location
Type: object · CreatePropertyLocationRequest nullable

Location data: latitude, longitude, country (ISO 3166-1 alpha-2), locality.
- country
  Type: null | string
- latitude
  Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double
- locality
  Type: null | string
- longitude
  Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double
operatingCosts
Type: object · Price nullable

Annual operating costs.
- currency
  Type: string
  min length:
  3
  max length:
  3
  required
  
  ISO 4217 currency code (e.g., "SEK", "EUR", "USD").
- value
  Type: number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  min:
  0
  required
  
  Price value. Multiply by scale factor to get actual amount. Example: value=1500 with scale="millions" = 1.5 billion.
- scale
  Type: string
  
  Scale factor for the value: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.
parcelArea
Type: object · Area nullable

Parcel area. Write requests must include unit "sqm".
- unit
  Type: string
  required
  
  Area unit. Write requests must include "sqm"; read responses are normalized to "sqm".
- value
  Type: number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  required
  
  Area value.
price
Type: object · Price nullable

Investment price.
- currency
  Type: string
  min length:
  3
  max length:
  3
  required
  
  ISO 4217 currency code (e.g., "SEK", "EUR", "USD").
- value
  Type: number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  min:
  0
  required
  
  Price value. Multiply by scale factor to get actual amount. Example: value=1500 with scale="millions" = 1.5 billion.
- scale
  Type: string
  
  Scale factor for the value: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.
tags
Type: array string[] | null

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

Tenure: freehold or leasehold.
yearBuilt
Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

Year the property was built.
zoning
Type: object · CreateZoningRequest nullable

Zoning information: permitted GFA and zoning categories.
- categories
  Type: array string[] | null
  
  Zoning categories: residential, office, retail, industrial, hotel, etc.
- gfa
  Type: object · Area nullable
  
  Permitted gross floor area. Must include unit "sqm".