Skip to main content
PUT
Update a building
This call changes a real building. Other apps and users in your organization see the change. You cannot clear a field through the API, so a value you set stays until you replace it with another value.
The update is partial. Nothing is required. A field you leave out, send as null, or send as an empty string keeps its stored value.
  • address replaces the stored address as a whole. Send address1, city, zip, and country whenever you send address. The API looks up the new address again and updates the location and the time zone.
  • site replaces the stored site group. Send both identifier and name.
  • name must stay unique in your organization, ignoring case.
  • baseTemp is in °F and area is in square feet.
  • The API ignores published, status, products, tags, picture, and tz if you send them. To publish a building, use Set the status of a building.
The limits are the same as in Create a building.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Path Parameters

buildingId
string
required

Building identifier from List buildings.

Body

application/json
name
string
Maximum string length: 50
primaryFunction
string
address
object
baseTemp
number<double>
yearBuild
integer<int32>
Required range: 1600 <= x <= 2100
area
integer<int32>
Required range: x >= 0
region
string
Maximum string length: 255
brand
string
Maximum string length: 255
zone
string
Maximum string length: 255
district
string
Maximum string length: 255
identifier
string
Maximum string length: 255
phoneNumber
string
site
object

Response

The building after the update.

_id
string
organizationId
string
createdAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

updatedAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

name
string
identifier
string
area
object
yearBuild
integer<int32>
primaryFunction
string
tags
string[]
address
object
picture
string
tz
string
areasCount
integer<int32>
devicesCount
integer<int32>
connectorsCount
integer<int32>
systemsCount
integer<int32>
pointsCount
integer<int32>
stats
object
baseTemp
number<double>
published
boolean
ossEnabled
boolean
climateZone
object
region
string
brand
string
zone
string
district
string
phoneNumber
string
site
object
products
object[]