website logo
⌘K
Getting Started
What is TIDY?
Getting Started: Rental Properties
Getting Started: Employer Benefits
Getting Started: Residential Homes
Getting Started: Offices
Dashboard
TIDY AI
Acceptance Probability
Teams & Users
Users
Teams
Properties/Addresses
Access Instructions
Jobs
Add or Request a Job
View, Edit, or Cancel Jobs
Setting Backup Times
Job Links
Job Reviews or Feedback
Resolving Pro Cancellations
Account Settings
Messages
Notifications
Plans
Access Control / Smartlocks
My Pros
Booking Different Type Of Services With Your Pros
Private Cleaning Payment
Defining your Job Request Strategy
To-Do Lists
Video Introductions
To-Do List Links
To-Dos
Do-Nots
Remote Inspections
Custom Fields
Laundry or Linens
Supply Preferences
Integrations
Automatic Booking
Billing, Pricing, & Payments
Billing History
Sending Payments
Bills & Payment Methods
Team Billing
View & Edit Prices
Viewing Billing History
Tips
Refunds
Rebate Program
Tax Reporting for Payments to Pros
Compliance, Ratings, Safety, Insurance, & Protection
Insurance or Custom Requirements
Certifications & Ratings
Satisfaction Guarantee, Disputes, & Protection
Damage Claims
Property Maps
Maintenance
Inventory Tracking
Inspections
Smart Thermostats
Issue Tracking
Automatic Translation
Other Questions
TIDY Concierge
Reports
Accounting
Developers
API Introduction
Authentication
Changelog
Errors
API Reference
Webhooks
Best Practices
Docs powered by archbee 

Create a Guest Reservation

2min
POST

Creates a Guest Reservation.

To create a GuestReservation you must enter an address_id and the date attribute for check_in and check_out. This represents the duration of the GuestReservation.

Another optional attribute for check_in and check_out is time. If no time is given, by default, the check in time will be set to '14:00' and the check out will be set to '11:00'

AUTHENTICATION
Authorization
string
Bearer
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
*
Date and time of when the `GuestReservation` was created. UTC and ISO formatted




Updated 26 Apr 2023
Did this page help you?
Yes
No
PREVIOUS
List Guest Reservations
NEXT
Retrieve a Guest Reservation
Docs powered by archbee