Update a building
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Path Parameters
The id identifier.
Body
Whether the building is currently active.
The physical address of the building.
An arbitrary description attached to the building.
Marketing details displayed for the building.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
The name of the building.
The type of the building.
block_management, commercial, residential, student Default fees applied to units in this building.
Weekly viewing hours for this building. Omit to leave unchanged. null inherits the account viewing calendar.
Whether bookings from this building's public viewing link need confirmation. Omit to leave unchanged. null inherits the account setting.
Response
Returns the building object if the update succeeded.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
building Whether the building is currently active.
The physical address of the building.
The default currency used for the building.
An arbitrary description attached to the building.
Marketing details displayed for the building.
The name of the building.
Whether the building can be deleted.
Whether the building is treated as a single unit.
The type of the building.
block_management, commercial, residential, student, null Default fees applied to units in this building.
The public URL a lead can use to book a viewing at this building. Present once a booking link has been minted.
Weekly viewing hours for this building. null inherits the account viewing calendar. An empty object means the building offers no self-serve slots.
Whether bookings from this building's public viewing link need a team member to confirm them. null inherits the account setting.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.