Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Calendar

Update the calendar for a single listing

Set the nightly rate, minimum stay and availability of any calendar date per listing.

put/availability-pricing/api/calendar/listings/{id}

Path parameters

idstring required

Listing ID

Request body

startDatestring date required

First day affected by changes (format: YYYY-MM-DD)

endDatestring date required

Last date affected by changes (format: YYYY-MM-DD)

status'available' | 'unavailable'

New status, enum: available, unavailable.

pricenumber

New price, in the listing's currency.

isBasePriceboolean

Whether to reset prices for the range to the listing's base price

minNightsinteger

New min nights value

isBaseMinNightsboolean

Whether to reset min nights for the range to the listing's base min nights

notestring

Note to add to those dates.

ctaboolean

Set Closed To Arrival for the date range.

ctdboolean

Set Closed To Departure for the date range.

useChildValuesboolean

Accept changes to minNights on sub-unit

blockReason'Owner block' | 'Offboarded' | 'Migrated unit block' | 'Maintenance' | 'Onboarding' | 'Emergency out of order' | 'Do not sell' | 'Deactivated' | 'Other'

Reason for blocking, enum: Owner block, Offboarded, Migrated unit block, Maintenance, Onboarding, Emergency out of order, Do not sell, Deactivated, Other.

Example request

{
  "startDate": "2023-01-01",
  "endDate": "2023-02-01",
  "status": "available",
  "note": "this is a note",
  "blockReason": "Onboarding"
}

Response

Returns ok if the update successful

string required

Example response

"ok"