Request: POST /api/v2/mls_unlock
(Note: Calling this api will bypass many security checks, please proceed with caution)
Security Header
| Header Name | Value |
|---|---|
| Authorization | Bearer 3d48f9ccf28d47619d323ff7e4d96a59d1ac34eaxxxxxxxxxxxxxxx |
Body
| Parameter | Description | Example | Required |
|---|---|---|---|
| serial | Lock serial number | 123456 | Yes |
| start_time | Start time for lock code access, provided as a UTC timestamp in epoch format | 1539736007 | Yes |
| end_time | End time for lock code access, provided as a UTC timestamp in epoch format. (If end_time is not provided for a periodic code, it defaults to the end of the day in the lock's timezone.) | 1539746007 | Optional |
| name | Name for this unlock code, which will show on Rently Manager portal | Optional | |
| phone | Phone number for this unlock code | Optional |
{
"serial": "123456",
"name": "mls agent name",
"phone": "mls agent phone number",
"start_time": "1539736007",
"end_time": "1539746007"
}
Lockboxes :
Generated codes are one day code. Date would be determined based on the start_time and lock's timezone.
For Rently Blue Locks:
Generated codes are a period code, last between start_time and end_time (if end_time is not provided then it defaults to the end of the day in the lock's timezone).
For Smart Bolt Locks:
Generated codes are a one-time use code since start_time, which will auto expire after 3 hours even no use
Response
Success:
{
"success": true,
"code": "237689"
}
Failure:
{
"success": false,
"message": "Sorry, code could not be generated for 123456"
}
Other Response Code:
| Status Code | Error Code | Message |
|---|---|---|
| 401 | UNAUTHORIZED | |
| 404 | Not Found | |
| 422 | Unprocessable Entity | e.g. Start Time is required in epoch format |