This function is intended for partners managing housekeeping and maintenance on their own systems and wishing to update MiniHotel with real-time room cleaning statuses.
Cleaning statuses can be customized and aligned on the MiniHotel side to match the partner’s operational needs.If you want to retrieve the current room cleaning status, you can use this function instead, and follow the rm_status parameter.
HTTP Request Method = POST.
| Sandbox Endpoint | Production Endpoint |
|---|---|
https://sandbox.minihotel.cloud/api/Agents/Rooms/UpdateCleanStatus | https://api2.minihotel.cloud/api/Agents/Rooms/UpdateCleanStatus |
Request
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| roomNumber | String | MiniHotel internal room number |
| status | String | Cleaning status code (C = Clean, D = Dirty) |
Request Example
{
"roomNumber": "002",
"status": "C"
}
Response
Successful Response Fields
| Field | Type | Description |
|---|---|---|
| statusCode | String | Response status code |
| message | String | Status message |
Response Example
{
"statusCode": "0",
"message": "OK"
}
Error Responses
Room Not Found
{
"statusCode": 3,
"message": "Room was not found"
}
Invalid Clean Status Code
{
"statusCode": 4,
"message": "Invalid clean status code"
}
Cleaning Statuses
There are two core room cleaning statuses in MiniHotel: Clean (C) and Dirty (D).
On MiniHotel’s side, status codes must be single-letter values only (for example: A, B, L).
MiniHotel users, together with the MiniHotel support team, can define and customize additional cleaning statuses to match the partner’s and hotel’s operational needs.
Best practice is for the partner to map their internal statuses to the corresponding MiniHotel status codes.
Examples:
Partner status “Clean” → mapped to MiniHotel status “C”
Partner status “Refresh” → mapped to MiniHotel status “R”
Partner status “Inspected” → mapped to MiniHotel status “I”
C: Clean (Core status)
D: Dirty (Core status)
R: Refresh (Optional, but common)
Other values can be customized in the system setup
