Stays

Update a stay

Only the fields given change. trip_id re-files it on another trip in the same account.

patch/api/stays/{id}

Request

  • Base URL: https://trvlrr.app
  • URL: https://trvlrr.app/api/stays/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The id.

Request body

propertystring

Hotel or place name.

providerstring nullable

Booked with, e.g. Booking.com or the hotel chain.

citystring nullable

City the stay is in.

countrystring nullable

Country (name or ISO code).

localitystring nullable

The city it belongs to, when the label is a suburb or area.

locality_countrystring nullable

ISO alpha-2 of that city.

addressstring nullable

Street address.

check_instring nullable

Check-in date. Date, YYYY-MM-DD.

check_outstring nullable

Check-out date. Date, YYYY-MM-DD.

check_in_timestring nullable

Check-in time, HH:MM local; empty means mid-afternoon.

check_out_timestring nullable

Check-out time, HH:MM local; empty means late morning.

booking_refstring nullable

Confirmation number.

price_rawstring nullable

Price with currency, e.g. "EUR 540".

room_typestring nullable

Room type.

guestsinteger nullable

Number of guests.

latnumber nullable

Latitude.

lonnumber nullable

Longitude.

tzstring nullable

IANA time zone.

check_in_utcstring nullable

Derived; only set to override.

check_out_utcstring nullable

Derived; only set to override.

statusstring nullable

Free text, e.g. "Confirmed".

notesstring nullable

Anything else worth keeping.

agencystring nullable

Booked through.

payment_status'paid' | 'due' | 'on_arrival' | 'null' nullable

paid, due (to pay before the trip) or on_arrival (pay there or on the day).

payment_method'card' | 'cash' | 'null' nullable

card or cash.

traveler_idsstring[]

Who stayed; defaults to the trip's travellers.

trip_idstring

Move the stay to this trip (same account, both writable).

Response

Updated.

okboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.