Mobile Keys
Digital room keys for guest phones.
List mobile keys
Path Parameters
Confirmation number from the Partner API reservation.
Example:KH4DEMO01
Response
application/json
Response
Keys issued for this stay.
Show Child Parameters
Authentication
Path Parameters
Issue a mobile key
Write. Issues a key to one device. Only available once the stay is checked_in and a room is assigned. Up to 4 active keys per stay.
Path Parameters
Confirmation number from the Partner API reservation.
Example:KH4DEMO01
Headers
Optional. Makes the request safe to retry for 24 hours.
<= 255 characters
Body
application/json
Body
MobileKeyRequest
Stable identifier for the guest’s device.
<= 128 characters
Allowed values:iosandroid
Shown on the key, e.g. for a second guest in the room.
<= 100 characters
Response
application/json
Response
Key issued.
Show Child Parameters
Authentication
Path Parameters
Headers
Body
Revoke a mobile key
Write. Use when a guest loses or replaces their phone.
Path Parameters
Confirmation number from the Partner API reservation.
Example:KH4DEMO01
Example:key_7Hq2mX
Response
Response
Revoked.
Authentication
Path Parameters
Service Requests
Free in-stay requests to the property team: housekeeping, amenities, maintenance and concierge.