CLcloudbeds
Housekeeping

postHousekeepingStatus

Switches the current date's housekeeping status for a specific room ID to either clean or dirty The housekeeping status is calculated basing on the set of fields roomOccupied | roomCondition | roomBlocked | vacantPickup | roomBlocked | refusedService The available statuses are: - Vacant and Dirty (VD): false | “dirty” | false | false | false | false - Occupied and Dirty (OD): true | “dirty” | false | false | false | false - Vacant and Clean (VC): false | “clean” | false | false | false | false - Occupied and Clean (OC): true | “clean” | false | false | false | false - Occupied and Clean Inspected (OCI): true | “inspected” | false | false | false | false - Vacant and Clean Inspected (VCI): false | “inspected” | false | false | false | false - Do Not Disturb (DND): if doNotDisturb is true - Refused Service (RS): if refusedService is true - Out of Order (OOO): if roomBlocked is true - Vacant and Pickup (VP): if vacantPickup is true

post/postHousekeepingStatus

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postHousekeepingStatus
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:housekeeping

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

roomIDstring

Room ID

roomCondition'dirty' | 'clean' | 'inspected' nullable

New room condition. If no optional parameters are sent, will switch from current room condition. "inspected" status is available only if the property has the feature enabled.

doNotDisturbboolean nullable

New "do not disturb" status

roomCommentsstring nullable

New room comments.

refusedServiceboolean nullable

New "refused service" status

vacantPickupboolean nullable

New "vacant_pickup" status

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

No recorded changes to this operation across all 2 revisions of this API.