Create a building
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The physical address of the building.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
gbp, usd, eur, sek "gbp"
The name of the building.
Whether the building is currently active.
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.
Whether the building is treated as a single unit.
The type of the building.
block_management, commercial, residential, student Default fees applied to units in this building.
Response
Returns the task object if the request 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 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.