CLcloudbeds
Door Locks

Create a new doorlock key.

post/doorlock/v1/keys

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/doorlock/v1/keys
  • Auth
    OAuth 2
    Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
    Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: write:doorLockKey

Request body

propertyIdstring required
reservationIdstring required

Reservation identifier.

subReservationIdstring required

Sub-reservation identifier.

issuerIdstring required
startDateTimestring Y-m-d\TH:i:sP required

Start date and time of key.

endDateTimestring Y-m-d\TH:i:sP required

End date and time of key.

keyType'key_card' | 'access_code' | 'mobile_key' required

Key type.

roomsstring[]

List of common room IDs.

commonRoomsstring[]

List of common room ids.

externalIdstring nullable
keyCodestring nullable

Custom key code.

status'processing' | 'completed'

Key status.

encoderstring nullable
mobileIdstring nullable
guestIdstring nullable

Example request

{
  "rooms": [
    "1",
    "2",
    "3"
  ],
  "commonRooms": [
    "1",
    "2",
    "3"
  ]
}

Response

A key that was just created.

keyIdstring required
propertyIdstring required
reservationIdstring required
subReservationIdstring required
issuerIdstring required
guestIdstring nullable
roomsstring[] required
commonRoomsstring[] required
startDateTimestring Y-m-d\TH:i:sP required
endDateTimestring Y-m-d\TH:i:sP required
encoderstring nullable
keyCodestring nullable
keyTypestring required
mobileIdstring nullable
externalIdstring nullable
statusstring required
errorMessagestring nullable
createdAtstring required
updatedAtstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.