Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
units
/
{unitUuid}
/
assign-lock
Assign a physical lock to a unit
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/units/{unitUuid}/assign-lock \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "lockId": "86U7U7U2",
  "lockCode": "5555",
  "reason": "Assigned Vacant"
}
'
{
  "dateCreated": "2026-01-22T10:30:00.000Z",
  "dateUpdated": "2026-01-22T10:30:00.000Z",
  "unitUuid": "550e8400-e29b-41d4-a716-446655440000",
  "lockCode": "5555"
}

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

Facility UUID

​
unitUuid
string
required

Unit UUID

Body

application/json
​
lockId
string
required

Lock serial number

Maximum string length: 255
Example:

"86U7U7U2"

​
lockCode
string
required

Lock access code

Maximum string length: 32
Example:

"5555"

​
reason
enum<string>
required

Reason for lock assignment

Available options:
Assigned Vacant,
Overlocked
Example:

"Assigned Vacant"

Response

Lock assigned successfully

​
dateCreated
string<date-time>
required

Date when the lock assignment was created

Example:

"2026-01-22T10:30:00.000Z"

​
dateUpdated
string<date-time>
required

Date when the lock assignment was last updated

Example:

"2026-01-22T10:30:00.000Z"

​
unitUuid
object
required

UUID of the unit

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
lockCode
string
required

Lock access code

Example:

"5555"