Mobile Keys

Digital room keys for guest phones.

List mobile keys

get
https://stay.konghotels.cloud/stays/{confirmationNumber}/keys

Path Parameters

confirmationNumberstringrequired

Confirmation number from the Partner API reservation.

Example:KH4DEMO01

Response

application/json

Keys issued for this stay.

dataarray[object]required
Show Child Parameters
get/stays/{confirmationNumber}/keys
 
application/json

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.

post
https://stay.konghotels.cloud/stays/{confirmationNumber}/keys

Path Parameters

confirmationNumberstringrequired

Confirmation number from the Partner API reservation.

Example:KH4DEMO01

Headers

Idempotency-Keystring

Optional. Makes the request safe to retry for 24 hours.

<= 255 characters

Body

application/json

MobileKeyRequest

device_idstringrequired

Stable identifier for the guest’s device.

<= 128 characters

platformstringrequired

Allowed values:iosandroid

guest_namestring | null

Shown on the key, e.g. for a second guest in the room.

<= 100 characters

Response

application/json

Key issued.

dataobjectrequired
Show Child Parameters
post/stays/{confirmationNumber}/keys

Body

{ "device_id": "device_id", "platform": "ios" }
 
application/json

Revoke a mobile key

Write. Use when a guest loses or replaces their phone.

delete
https://stay.konghotels.cloud/stays/{confirmationNumber}/keys/{keyId}

Path Parameters

confirmationNumberstringrequired

Confirmation number from the Partner API reservation.

Example:KH4DEMO01

keyIdstringrequired

Example:key_7Hq2mX

Response

Revoked.

delete/stays/{confirmationNumber}/keys/{keyId}
 

Service Requests

Free in-stay requests to the property team: housekeeping, amenities, maintenance and concierge.