Sign in
Reservations

Updates a booking

Updates an existing Booking with the provided details. Note that not all fields can be updated via this endpoint.

put/v1/reservation/booking/{id}

Path parameters

idinteger required

The booking identifier

Request body

idinteger

The unique identifier for the booking or enquiry.

typestring nullable

The type of the record (e.g., "Booking" or "Enquiry").

booking_typestring nullable

Specifies whether this is a booking or an enquiry.

statusstring nullable

The current status of the booking or enquiry.

sourcestring nullable

The origin source of the booking or enquiry.

source_textstring nullable

The textual description of the source.

arrivalstring nullable

The arrival date in yyyy-MM-dd format.

departurestring nullable

The departure date in yyyy-MM-dd format.

peopleinteger nullable

The number of people included in the booking or enquiry.

property_idinteger nullable

The unique identifier of the property associated with the booking or enquiry.

property_namestring nullable

The name of the property associated with the booking or enquiry.

created_atstring date-time

The date and time when the booking or enquiry was created.

is_repliedboolean

Indicates whether a reply has been sent to the renter.

updated_atstring date-time

The date and time when the booking or enquiry was last updated.

is_deletedboolean

Indicates whether the booking or enquiry has been deleted (moved to trash).

date_deletedstring date-time nullable

The date and time of deletion, if applicable.

total_amountnumber double nullable

The total monetary amount for the booking or enquiry.

total_paidnumber double

The total amount already paid for the booking or enquiry.

amount_to_paynumber double nullable

The remaining amount to be paid for the booking or enquiry.

thread_uidstring uuid

The unique identifier of the message thread associated with the booking.

notestring nullable

An administrative note regarding the booking.

payment_typestring nullable

(Obsolete. Use PaymentWebsiteId instead.) The payment type used for this booking.

payment_addressstring nullable

(Obsolete. Use PaymentWebsiteId instead.) The payment address associated with this booking.

payment_website_idinteger nullable

The identifier of the website selected as the payment gateway for this booking.

Response

OK

Changes

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