Developers
...
API Reference
guest-reservations
Create a Guest Reservation
POST
BODY PARAMETERS
body
object
address_id
integer
*check_in
object
*The check-in time for the `GuestReservation`. For example: If 2020-01-01 14:00 is the check-out date and time, insert that here.
check_out
object
*This is the check-out date and time. For example: If 2020-01-08 11:00 is the check-out date and time, insert that here.
RESPONSES
201
Created
GuestReservation
## About Guest Reservations
A GuestReservation is a booked stay at one of your Addresses.
Ex. A Client booking a week trip at one of your Addresses from Jan 1, 2022 to Jan 8, 2022, would be considered a `GuestReservation` with the `check_in` date of `2022-01-01` and `check_out` date of `2022-01-08`
Note: A `check_in` date and time MUST be earlier than the `check_out` date and time.
Automatic Booking for Guest Reservations must be set up in the App/Console. To learn more, visit https://help.tidy.com/integrations#ry-how-to-set-up-automatic-booking
## More details about Guest Reservations
| Attribute | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| address_id | The `Address` to which the `GuestReservation` belongs to |
| job_id | If present, the `Job` associated with this `GuestReservation` |
| check_in.date | Check-in date for the `GuestReservation` |
| check_in.time | Check-in time for the `GuestReservation` |
| check_out.date | Check-out date for the `GuestReservation` |
| check_out.time | Check-out time for the `GuestReservation` |
| created_at | Date and time of when the `GuestReservation` was created. UTC and ISO formatted |
object
string
*Type of object being returned
id
integer
*address_id
integer
*job_id
integer
*If there is a `Job` associated with this `GuestReservation`, this ID will appear
check_in
object
*check_out
object
*created_at
string
*Example: 2022-01-17T21:47:51Z
Date and time of when the `GuestReservation` was created. UTC and ISO formatted
Did this page help you?