UpdatePropertyRequest

Partial update body for PATCH /api/v1/properties/{id}. Send only the fields you want to change; omitted fields are left untouched. Where a nullable field accepts null, sending null explicitly clears the stored value.

avgContractLengthYears
Type: null | numberFormat: decimal
categories
Type: array object[] | null · CreatePropertyCategoryRequest[]
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
  
  Price as a single value, with currency and scale.
- 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
clearCoordinates
Type: null | boolean
description
Type: null | string
externalRefs
Type: array object[] · ExternalRef[] …10

External references for CRM integration. Replaces all existing external refs. Set to empty array to remove all external 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 · UpdatePropertyLocationRequest nullable

Partial update body for the location block on a property PATCH. Include only the coordinates and address parts you want to change; omitted fields are left untouched. Where a nullable field accepts null, sending null explicitly clears the stored value.
- country
  Type: null | string
- latitude
  Type: null | numberFormat: double
- locality
  Type: null | string
- longitude
  Type: null | numberFormat: double
name
Type: null | string
operatingCosts
Type: object · Price nullable

Price as a single value, with currency and scale.
- 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

Area measurement with value and unit.
- 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

Price as a single value, with currency and scale.
- 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
tenure
Type: null | string
yearBuilt
Type: null | integerFormat: int32
zoning
Type: object · UpdateZoningRequest nullable

Partial update body for the zoning block on a property PATCH. Include only the sub-fields you want to change; omitted fields are left untouched. Sending null for a nullable sub-field clears it.
- categories
  Type: array string[] | null
- gfa
  Type: object · Area nullable
  
  Area measurement with value and unit.