v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Reservations

Update Check-in Details

Update check-in details for a stay including lock code, arrival/departure times, and deposit information.

patch/reservations/{stay_code}/check_in_details

Path parameters

stay_codestring required

The code of the stay.

Request body

lock_codestring nullable

The lock code for the property, stored only in Hostex and shown in the check-in guide. This field is independent of any smart-lock channel integration and is NOT pushed to external smart-lock providers. Set to null to remove the lock code.

lock_code_visible_afterstring nullable

The time after which the lock code becomes visible, in HH:mm format (24-hour). Example: '14:00'. Set to null to remove the restriction.

depositinteger

The deposit amount in the host's currency. For example, if the currency is USD, 100 means 100 US Dollars.

id_required'not_required' | 'required' | 'required_with_review'

Whether the guest must register / upload identity documents (ID) for this stay before check-in. not_required = no ID required; required = guest must upload an ID, no manual review; required_with_review = guest must upload an ID and the host needs to manually review and approve it before check-in is unlocked.

Response

The request has been successfully submitted.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}