Skip to main content
PATCH
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
unitGroups
/
{unitGroupUuid}
/
assignUnits
Assign units to a unit group
curl --request PATCH \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/{unitGroupUuid}/assignUnits \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "unitUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'
true

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
​
unitGroupUuid
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 be of the same type and size (within 2ft tolerance) to be assigned to the same unit group.

Example:
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "3fa85f64-5717-4562-b3fc-2c963f66afa7"
]

Response

Units assigned to the unit group

The response is of type boolean.