Cloudbeds now allows properties using integrated door lock providers to automatically sync guest access codes into the Cloudbeds Guest Experience platform.
With this feature, access codes are displayed in the guest profile, and they can be automatically included in guest communications using dynamic variables, eliminating the need for manual copy and paste from the PMS.
To use automatic door lock code syncing, your property must have a supported door lock provider integrated with Cloudbeds PMS through the Door Locks API.
Properties using fixed room codes or door lock integrations that store codes in custom fields can also include those codes in guest communications using the appropriate variables.
This article explains how door lock codes work in Guest Experience and how to use them in your guest communications.
Which door lock variable should I use?
The correct variable depends on how your property manages door lock codes. Not all door lock integrations use the same variable or support automatic code syncing through the Door Locks API.
Fixed door lock codes without an integrated app
If your property does not use a door lock app and each room has a fixed access code, use:
room.door_lock_id
The code must be configured in the room's Accommodation Details in Cloudbeds PMS.
This variable retrieves the fixed door lock ID associated with the accommodation. It does not generate a new access code or retrieve codes from a third-party door lock integration.
Door lock integrations using the Door Locks API
If your property uses a supported integration that sends access codes through the Cloudbeds Door Locks API, use:
{{door_lock_code}}
This variable retrieves the access codes available through the Door Locks API integration. It supports the automatic syncing and code-display functionality described in the following sections of this article.
Integration compatibility: Not every door lock provider connected to Cloudbeds PMS uses the Door Locks API. Confirm that your provider supports this integration before using the Door Lock Code variable.
Door lock integrations using custom fields
Some door lock integrations do not use the Cloudbeds Door Locks API. Instead, they store access codes in custom fields that can be referenced in guest communications.
Common examples include:
-
Lynx:
cloudbeds_lynx_multiple_access_codeorcloudbeds_lynx_access_code -
Operto:
cloudbeds_check_in_code -
Jervis:
cloudbeds_door_code
Select the corresponding custom field variable in Guest Experience when creating a message or automation. The field must contain an access code for the reservation.
These custom field names are not interchangeable with {{door_lock_code}}. Use the variable associated with your property's integration.
How it works
When a door lock access code is generated or updated in the PMS or via a supported door lock provider using the Door Locks API, Guest Experience automatically syncs this information in real-time.
The following events trigger updates:
- A new access code is created
- An existing access code is updated (e.g., room change or stay extension)
GX stores the following information for each key:
- Door or room name
- Access code
- Key type
- Validity dates
- An initial sync is also performed when the integration is activated to retrieve all active keys.
Where to View Door Lock Codes
Door lock codes synced through the Door Locks API are available in the guest profile within Guest Experience interfaces:
- Cloudbeds Guest Experience Dashboard: In the Doorlock Keys tab in the conversation sidebar.
- Cloudbeds PMS Inbox: In the Digital Keys section of the guest profile sidebar.
Each entry displays the associated door or room, access code, key type, and validity period.
Use Door Lock Codes in Messages
For integrations using the Door Locks API, you can include door lock access codes in your guest communications using the Door Lock Code dynamic variable: {{door_lock_code}}.
If your property uses fixed accommodation codes or an integration that stores codes in custom fields, use the corresponding variable described in Which door lock variable should I use? instead.
This variable is available in:
- Message templates
- Automated messages
- Conversations
- Digital documents
Door Lock variable behavior:
-
Door Lock Code - Displays all active keys
- If one code exists → the code is inserted
- If multiple codes exist → all codes are listed (e.g., "Room 101 - 4567, Main Entrance - 7890")
- If no code exists → the system will return a variable error.
- Door Lock Code Key Card - Will only display key cards
- Door Lock Code Access Code - Will only display keys created as access codes.
- Door Lock Code Mobile Key - Will only display mobile keys
The variable is resolved at send time, using the latest access code available in Guest Experience from the Door Locks API integration.
Limitations
- Access codes are not displayed in the Guest Portal
- Door lock keys cannot be created or managed from Cloudbeds Guest Experience
- Keys cannot be revoked or modified from Guest Experience
- Lock status (battery, door status, etc.) is not available
- Door lock codes are not available as merge tags in Cloudbeds PMS.
- The Door Lock Code variable is intended for integrations using the Cloudbeds Door Locks API. Fixed accommodation codes and custom-field-based integrations require their corresponding variables.
Related Articles
Comments
Please sign in to leave a comment.