Skip to main content
PATCH
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
unitGroups
/
sizeAndType
/
{sizeAndTypeUuid}
/
rate
Patch unit group rate by size and type
curl --request PATCH \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/{sizeAndTypeUuid}/rate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "baseWebRateInPennies": 1,
  "baseStreetRateInPennies": 1,
  "tierDescription": "Essential"
}
'

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
baseWebRateInPennies
number
required
Required range: x >= 0
baseStreetRateInPennies
number
required
Required range: x >= 0
tierDescription
enum<string>
required

Tier name of the target unit group. Must be one of: Premium, Preferred, Essential.

Available options:
Premium,
Preferred,
Essential
Example:

"Essential"

Response

200

Unit group rate patched