Deactivate a property
Marks a property inactive. The call is refused while the property still has active units unless forceDeactivateChildren is set, which deactivates them — and ends their leases — in the same call.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Path parameters
propertyIdstringrequiredSnowflake id of the property, as a decimal string.
example: 1830472847398404097
Query parameters
forceDeactivateChildrenbooleanLeave it false and the call is refused with a 409 while any of the property's units is still active. Set it true to deactivate those units — and end their leases — as part of the same call.
default: false
Response
200 · The property is now inactive. The response has no body.
401 · The access token is missing, expired, or not for this company.
404 · No property with that id, or it belongs to another company.
409 · The property still has active units and `forceDeactivateChildren` was not set. The problem document's `detail` says how many are in the way, and `entityId` is the property.
It is a DELETE, but nothing is deleted
Deactivating flips the property's active flag to false. The record, its units and their leases all stay. Use the delete endpoint when you really want the rows gone.