Skip to main content
PUT
Set a unit unrentable or vacant

Headers

x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

facilityUuid
string
required
portfolio
string
required
unitUuid
string
required

Body

application/json
unitOccupancyStatus
enum<string>
required

Target occupancy status. Only UNRENTABLE and VACANT can be set through this endpoint; every other transition is driven by a rental.

Available options:
UNRENTABLE,
VACANT
Example:

"UNRENTABLE"

unrentableReasonUuid
string<uuid>

Why the unit is unrentable, from GET units/unrentable-reasons. Ignored when the target status is VACANT.

Example:

"a4201001-0000-4000-8000-000000000002"

Response

Occupancy status updated successfully