OWownerrez
Quotes

Partially update a quote.

Changed on
patch/v2/quotes/{id}

Request

  • Base URL
    https://api.ownerrez.com
  • URL
    https://api.ownerrez.com/v2/quotes/{id}
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idinteger required

The Id of the quote to update.

Request body

adultsinteger

The quoted number of adults.

arrivalstring date

The quoted date of arrival in property time zone in yyyy-MM-dd format, e.g. 2024-10-31.

check_instring nullable

The quoted arrival checkin time in property time zone in 24 hour HH:mm format, e.g. 16:00. (NULL use property default)

check_outstring nullable

The quoted departure checkout time in property time zone in 24 hour HH:mm format, e.g. 09:00. (NULL use property default)

childreninteger

The quoted number of children.

departurestring date

The quoted date of departure in property time zone in yyyy-MM-dd format, e.g. 2024-10-31.

discount_codestring nullable

Optional discount code to apply to the quote.

expires_utcstring date-time nullable

The date this quote expires (UTC). Omit or null to use property default (QuoteExpirationDays).

generate_chargesboolean

Whether to generate charges on the quote. Default is true. For PATCH, when true, charges will be regenerated (reset).

generate_emailboolean

Whether to generate and send email system messages after creating the quote. Default is false.

guest_idinteger

The ID of the guest this quote was created for. Required unless test is true. A PATCH can change the guest but not remove it. For a visitor whose details aren't known yet, create the guest first with POST /v2/guests, which needs no fields.

hold_datesboolean

Whether to create a hold block for the quoted dates. Default is false.

infantsinteger

The quoted number of infants.

listing_site_idinteger nullable

The listing site this quote is attributed to. Use the Id from the listing sites endpoints.

notesstring nullable

Notes about this quote.

petsinteger

The quoted number of pets.

property_idinteger

The quoted property ID.

redirect_after_booking_urlstring nullable

Where to send the guest after they complete a booking from this quote, overriding the property's setting. Must be an absolute URL beginning with http:// or https://. Omit, null, or blank to use the property's setting.

testboolean

Indicates that the generated quote should be returned only, not stored. When true, the quote operation (POST/PATCH) will be validated and processed (including charge generation if requested) but not committed to the database. Default is false.

validate_rulesboolean

Whether to validate property rules (min/max nights, etc.). Default is true.

Response

A model representing the updated quote.

idinteger

The ID of this record.

tagsstring[]

A collection of tag names.

adultsinteger

The quoted number of adults.

arrivalstring date

The quoted date of arrival.

check_instring

The quoted arrival checkin time.

check_in_endstring

The quoted arrival checkin end time.

check_outstring

The quoted departure checkout time.

childreninteger

The quoted number of children.

created_utcstring date-time

The date this quote was created in the system.

departurestring date

The quoted date of departure.

expires_utcstring date-time

The date this quote expires.

guest_idinteger

The ID of the guest this quote was created for.

infantsinteger

The quoted number of infants.

keystring guid

A globally unique ID for this quote.

listing_sitestring

The listing site this quote is attributed to.

listing_site_idinteger nullable

The Id of the listing site this quote is attributed to. Use the Id from the listing sites endpoints.

notesstring

Notes about this quote.

payment_formstring

The URL of the public payment form for this quote. Send the guest here to review the quote and complete the booking. Null for a test quote.

petsinteger

The quoted number of pets.

platform_email_addressstring

A proxy email address provided by the OTA specifically for this quote.

property_idinteger

The quoted property ID.

quoted_utcstring date-time

The date this quote was made.

redirect_after_booking_urlstring

Where the guest is sent after they complete a booking from this quote. When null, the property's setting applies at booking time. Quotes created in the control panel start with a copy of the property's setting, so a value here is not proof the host set one per quote.

thread_idsinteger[]

Message threads for this quote. Read a thread's messages with GET /v2/messages?threadId={id}.

updated_utcstring date-time nullable

The date this quote was last updated in the system.

Changes

  • 35db8ad62f61Revision changes
    • breaking

      the request property format changed from date-time to date

    • breaking

      the request property format changed from date-time to date

  • 838877899156Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status