Skip to main content
PATCH
Patch unit group rate by size and type

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

portfolio
string
required

Body

application/json
currentWebRateInPennies
number
required

Web rate to charge for the target unit group, in pennies. The value is applied through the unit group base rate, so the resulting currentWebRateInPennies is derived from the unit group rate plan and occupancy percentage and may differ from the value sent.

Required range: x >= 0
Example:

15000

currentStreetRateInPennies
number
required

Street rate to charge for the target unit group, in pennies. The value is applied through the unit group base rate, so the resulting currentStreetRateInPennies is derived from the unit group rate plan and occupancy percentage and may differ from the value sent.

Required range: x >= 0
Example:

18000

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

Unit group rate patched

unitGroupUuid
string<uuid>
required

UUID of the unit group the rate was applied to

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

currentStreetRateInPennies
number
required

Street rate now being charged for the unit group, in pennies, after the rate plan and occupancy derivation

Example:

18000

currentWebRateInPennies
number
required

Web rate now being charged for the unit group, in pennies, after the rate plan and occupancy derivation

Example:

15000

occupancyPercentage
number
required

Occupancy percentage used to derive the rates

Example:

80