Update Reservation

Updates reservation details including guest information, check-in/out times, and notes. On internal and direct reservations it can also move the dates and change the guest count and payout.

The updated values are stored with the reservation and will be used when:

  • Generating messages (message tags like {{Check-In Time}}, {{Guest First Name}}, etc.
    will reflect the updated values)
  • Calculating lock code access periods (custom check-in/out times affect when codes are valid)

startDate, endDate, guests, hostPayout and guestPrice can only be changed on reservations with source internal or direct. Sending any of them for a channel reservation (Airbnb, VRBO, Booking.com, etc.) returns a 400; change those on the channel and Host Tools picks the change up.

Moving the dates re-checks availability: the request is rejected with a 400 if the new dates overlap another reservation on the listing. Scheduled messages and lock codes follow the new dates, and so does the calendar on connected channels when Host Tools syncs the listing's availability. The payout is not recalculated, and a direct booking's Stripe payment is not re-charged or refunded; send hostPayout and guestPrice if they changed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

_id of reservation to update

Body Params

Reservation update fields

string | null

URL of the guidebook

string | null

URL of the verification

string | null
enum

Status of the verification

Allowed:
string | null

URL of the incident

string

Guest's first name (used in {{Guest First Name}} tag)

string

Guest's last name (used in {{Guest Last Name}} tag)

string

Guest's email address

string

Guest's phone number (used in {{Guest Phone}} and {{Guest Lock Code}} tags)

string | null

Custom smart lock code. Set to null or empty string to clear and use auto-generated code.

number
0 to 23

Custom check-in time in hours (0-23), used in {{Check-In Time}} tag and lock code scheduling

number
0 to 23

Custom check-out time in hours (0-23), used in {{Check-Out Time}} tag and lock code scheduling

string

Internal notes for the reservation (used in {{Notes}} tag)

date

New check-in date (YYYY-MM-DD). Internal and direct reservations only. Can be sent without endDate to keep the current check-out.

date

New check-out date (YYYY-MM-DD), after startDate. Internal and direct reservations only. Can be sent without startDate to keep the current check-in.

guests
object

Guest count. Internal and direct reservations only. Only the fields you send change; set one to 0 to clear it. adults + children must not exceed the listing's capacity.

number
≥ 0

Host payout. Internal and direct reservations only.

number
≥ 0

Total price paid by the guest. Internal and direct reservations only.

Headers
string

Partner API key (deprecated — use OAuth 2.0 for new integrations)

string

User's authentication token (legacy). Use Authorization Bearer header for new integrations.

Responses

429

Too many requests

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json