Lock Unlock Code

Request: POST /api/lockboxes/mls_unlock

(Note: Calling this api will bypass many security checks, please proceed with caution)

Security Header

Once you get the access_token pass authorization header back to all subsequent requests

  • Name: Authorization
  • Value: Bearer 3d48f9ccf28d47619d323ff7e4d96a59d1ac34eaf9d859c592a44cff1fb49d33

Body

For lockboxes:

serial - Lockbox serial number

name - name for this unlock code, which will show on Rently Manager portal

phone - phone number for this unlock code

date - Lockbox local timezone date string for code accessing

{
  "serial": "123456",
  "name": "mls agent name",
  "phone": "mls agent phone number",
  "date": "2001-02-30"
}

For Rently Blue Locks:

Will grant a period code last between startime and endtime

serial - Lock serial number

name - name for this unlock code, which will show on Rently Manager portal

phone - phone number for this unlock code

starttime - code access start time in UTC timestamp

endtime - code access end time in UTC timestamp

{
  "serial": "123456",
  "name": "mls agent name",
  "phone": "mls agent phone number",
  "starttime": "1539736007",
  "endtime": "1539746007"
}

For Smart Bolt Locks:

Will grant a one-time use code since startime, which will auto expire after 3 hours even no use

serial - Lock serial number

name - name for this unlock code, which will show on Rently Manager portal

phone - phone number for this unlock code

starttime - code access start time in UTC timestamp

{
  "serial": "123456",
  "name": "mls agent name",
  "phone": "mls agent phone number",
  "starttime": "1539736007"
}

Response

Either success or error, as shown below:

{
  "success": true,
  "code": "123456"
}
{
  "success": false,
  "message": "optional error message here"
}