CLcloudbeds
Door Locks

Update a doorlock key.

patch/doorlock/v1/keys/{id}

Request

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

Path parameters

idstring required

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Request body

status'processing' | 'completed' | 'failed' | 'deleted' nullable
keyCodestring nullable
errorMessagestring nullable

Response

Updated key.

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.