---
updatedAt: 2026-04-21T15:20:46.000Z
agentTools:
  projectIndex: https://developers.cloudbeds.com/llms.txt
---

# Check-in

Updating guest data, documents, scanned files and adding them to the myfrontdesk reservations is easy. Check out a suggested solution below.

# Pre-Checkin: Update guest information

### (\*)Pre-Checkin feature certification mandatory requirements.

* Use [getReservations](https://developers.cloudbeds.com/reference/get_getreservations-2) with parameters status or `CheckInFrom`/`CheckInTo` and `CheckOutFrom`/`CheckOutTo` to get reservations for your specific purpose. e.g. Today's arrivals, today's departures.\*\*\*\*\*

* Use [putGuest](https://developers.cloudbeds.com/reference/put_putguest-2) to update guest data to existing guests (Specific attention on guest document information).\*\*\*\*\*

* Use [postGuest](https://developers.cloudbeds.com/reference/post_postguest-2) to upload data for new guests. Number of adults and children is specified on every reservation, don't allow more guests than specified.\*\*\*\*\*

* Use [postGuestDocument](https://developers.cloudbeds.com/reference/post_postguestdocument-2) to upload a file e.g. passport scan, photography.

* Use [postReservationDocument](https://developers.cloudbeds.com/reference/post_postreservationdocument-2) to upload a file referring to the entire reservation e.g. contract.

* Use [postReservationNote](https://developers.cloudbeds.com/reference/post_postreservationnote-2) to post any messages into myfrontdesk reservation.

<br />

<br />

## Check-in or check-out a guest

Flow for companies that update the status to check-in along with Door lock management:

* Use [putReservation](https://developers.cloudbeds.com/reference/put_putreservation-2) with status: `checked_in` to check in a guest or `checked_out` to check out a guest.

* Checking out a guest is currently possible only when there is no open balance, use [getReservation](https://developers.cloudbeds.com/reference/get_getreservation-2) to confirm that the reservation has been fully paid to be able to proceed with updating the reservation status to `checked_out`.

* If a room is not assigned, use [getRoomsUnassigned](https://developers.cloudbeds.com/reference/get_getroomsunassigned-2) to see available rooms and allocate a room before check-in using [postRoomAssign](https://developers.cloudbeds.com/reference/post_postroomassign-2).

<br />

### Charge for the stay

* Use [getReservation](https://developers.cloudbeds.com/reference/get_getreservation-2)  to get the amount due.

* Use [postPayment](https://developers.cloudbeds.com/reference/post_postpayment-2) to record the payment.

* Use [getReservation](https://developers.cloudbeds.com/reference/get_getreservation-2) or [getReservationsWithRateDetails](https://developers.cloudbeds.com/reference/get_getreservationswithratedetails-2) to see paymentCollect details and allow to charge for the amount due only if "Hotel" collects the payment.

<br />

### Assign a room on a reservation

* Use [getRoomsUnassigned](https://developers.cloudbeds.com/reference/get_getroomsunassigned-2) to get the list of the available rooms.

* Use [postRoomAssign](https://developers.cloudbeds.com/reference/post_postroomassign-2) to assign a room on a reservation.

<br />

### Kiosks: Check-in or check-out a guest

(\*\*\*\*\*)  Kiosk certification mandatory requirements.

* Use [getReservations](https://developers.cloudbeds.com/reference/get_getreservations-2) with parameters status or `CheckInFrom`/`CheckInTo` and `CheckOutFrom`/`CheckOutTo` to get reservations for your specific purpose, *e.g.* today's arrivals, today's departures. Only allow confirmed reservations to be checked-in.\*\*\*\*\*

* Use [putGuest](https://developers.cloudbeds.com/reference/put_putguest-2) to update guest data to existing guest (Specific attention on guest document information).\*\*\*\*\*

* Use [postGuest](https://developers.cloudbeds.com/reference/post_postguest-2) to upload data for new guests. Number of adults and children is specified on every reservation, don't allow more guest than specified.\*\*\*\*\*

* Use  [putReservation](https://developers.cloudbeds.com/reference/put_putreservation-2) with status: `checked_in` to check in a guest or `checked_out` to check out a guest. (\*\*\*\*\*)

* Checking out a guest is currently possible only when there is no open balance, use [getReservation](https://developers.cloudbeds.com/reference/get_getreservation-2) to confirm that the reservation has been fully paid to be able to proceed with updating the reservation status to checked\_out. Alternatively, to process the outstanding payment see **Charge for the stay** guidelines above.\*\*\*\*\*

* Guests should be able to check-in and check-out using the third-party id. Use `thidPartyIdentifier` to match with Cloudbeds reservationID.\*\*\*\*\*

* If a room is not assigned use [getRoomsUnassigned](https://developers.cloudbeds.com/reference/get_getroomsunassigned-2) to see available rooms and  allocate a room prior to check-in using [postRoomAssign](https://developers.cloudbeds.com/reference/post_postroomassign-2).\*\*\*\*\*

* Call [getHouseKeepingStatus](https://developers.cloudbeds.com/reference/get_gethousekeepingstatus-2)  or subscribe to the [housekeeping webhooks](https://developers.cloudbeds.com/docs/webhooks-1#housekeeping) to check if the room is occupied and its housekeeping status.

<br />

### Send email from myfrontdesk

* Use [postEmailTemplate](https://developers.cloudbeds.com/reference/post_postemailtemplate-2) to create an email template with the same custom field. Myfrondesk will send out the email to the guest.

* Use the [postEmailSchedule](https://developers.cloudbeds.com/reference/post_postemailschedule-2) to schedule the template either based on the reservation status change or a date.

<br />