Skip to main content
PATCH
Update units tier

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

Body

application/json
unitUuids
string<uuid>[]
required

Array of unit UUIDs to assign to the unit group. Units must be vacant, unrentable or owner occupied and belong to the same facility to be assigned to a unit group. Units must all be currently assigned to a unit group and belong to the same size and type group.

Example:
tierLevel
enum<number>
required

Tier level of the target unit group, independent of how the portfolio labels its tiers. 0 is the cheapest tier by convention and 2 the most expensive; the levels are positional identities, not a guarantee about relative price.

Available options:
0,
1,
2
Example:

0

Response

Units assigned to the unit group

The response is of type boolean.