Door Locks

This information applies only for the mobile key workflows. Key card workflows can't be integrated through the Cloudbeds API at the moment.

Initial pull

Use /getReservations to fetch any existing future reservations. You must subscribe to our webhooks to receive subsequent new reservations and reservation change updates. *

Send door codes to myfrontdesk

Send Checkin Door Lock Codes to myfrontdesk via CustomField, ReservationNote or via email to the guest.*

Use /postCustomField (with parameter applyTo=reservation) to create a custom field in a property. Then you can post door codes into a reservation or update them in case of any changes with putReservation. If multiple rooms are in a single reservation, you can update all door codes at the reservation level.

Note that custom fields are editable by the Cloudbeds users.

An alternative method of providing reception with the door code is by using the postReservationNote method. At the moment notes can't be fetched, updated or deleted via API.

Use putReservation with status: checked_in to check in a guest.*

(*)Door Lock feature certification mandatory requirements.

Create an email template with the door code

Optional: You can use postEmailTemplate to create an email template with the same custom field. Myfrondesk will send out the email to the guest. You can use postEmailSchedule to schedule the template either based on the reservation status change or a date.

Example: To schedule an email for the date of arrival set the parameter days to 0 and the parameter event to before_check_in.

Note: Use getEmailSchedule and getEmailTemplates to create the validation that prevents your app from creating multiple templates/schedules for the same properties.

Cloudbeds email template limitation: Same-day or walk-in reservations will receive the email template without the access code. Cloudbeds email schedule is configurable by day only meaning that same-day reservations will not have enough time to process the access code in the Cloudbeds system and will not be included in the Cloudbeds email template. The property will need to email the access code to the guest manually. Alternatively, you can choose a direct notification from your application to overcome this limitation.

It's recommended that you create a nice HTML template and make it look appealing to the guest with the headers and formatting. Plain text email templates will look strange and unsecured to guests that in fact need to check-in.

Check-in or check-out a guest

Use putReservation with status: checked_in to check in a guest.*

Checking out a guest is currently possible only when there is no open balance, use getReservationInvoiceInformation to confirm that the reservation has been fully paid to be able to proceed with updating the reservation status to checked_out.