Create Access

The post body should contain the necessary data to create the access as a JSON object:

{
    "user": {
        "id" : 123456,
        "email": "[email protected]",
        "mobile": "16042656073"
    },
    "key": { "id" : 123456, "serialNumber": "XXXXX" },
    "accessStartDate": "2016-07-21",
    "accessStartTime": "12:45",
    "accessEndDate": "2016-07-23",
    "accessEndTime": "12:45",
    "timeZone": "America/Vancouver",
    "name": "Bob S.",
    "returnReminder": false,
    "suppressGuestNotifications": false,
    "locale": "en",
    "allowSetup": false
}

Returns an access object if the call succeeded.

If you wish for the guest to not receive any communications from Keycafe, use the "suppressGuestNotifications" property to stop all communications from Keycafe, and provide the booking code and checkin link values to the guest through your own communications. They will be able to use the booking code (code entered into the SmartBox screen) or checkin link (mobile phone experience) at the Keycafe SmartBox to pickup keys.

📘

Offline Key Exchange Best Practice

To ensure a seamless key exchange experience with Offline Mode, it is recommended to communicate booking codes to users in advance or keep them available locally in your app. This approach avoids relying on API availability to retrieve and display booking codes during the key exchange, providing a reliable experience even in offline scenarios.

Date Formats

There are two methods for specifying access dates.

• ISO 8601 dates (deprecated).
• Separated date, time and timezone components.

The full ISO 8601 format option is deprecated because of inconsistent support for "local" times. With separated date/time/timezone components, a local access can be created by omitting the timezone. If the timezone is specified, the access start and end times will be adjusted to the location of the keys. For example, an access that ends at 00:00 in America/Vancouver will end at 03:00 in America/New_York. A local access that ends at 00:00 will end at midnight in both timezones.

• Omitting date/time data will result in an ongoing access.
• Omitting time data will result in an access that uses default start and end times (00:00-23:59).
• Omitting timezone data will result in a local access.