Params

NameTypeRequirenessDefault valueDescription
property_uidstringrequirednoneUID of property.
start_datestringrequirednoneYYYY-MM-DD Start of the updated period.
end_datestringrequirednoneYYYY-MM-DD End of the updated period.
is_availableintrequirednoneIs property available (1) or not (0).

Description

Block or unblock specific dates by property UID.

This endpoint requires the following scope: availability-control

Request sample

{
    "property_uid": "e3ddcd1a-0e3e-4649-91be-c59d7b50",
    "start_date": "2023-05-04",
    "end_date": "2023-05-09",
    "is_available": 1
}

Response samples

{
  "success": true,
  "availability": [
    {
      "date": "2023-01-26",
      "is_available": 1,
      "reason": null
    },
    {
      "date": "2023-01-27",
      "is_available": 0,
      "reason": "Blocked by reservation"
    },
    {
      "date": "2023-01-28",
      "is_available": 0,
      "reason": "Blocked by reservation"
    },
    {
      "date": "2023-01-29",
      "is_available": 1,
      "reason": null
    },
    {
      "date": "2023-01-30",
      "is_available": 1,
      "reason": null
    }
  ],
  "errors": []
}
{
  "success": false,
  "availability": [],
  "errors": [
    "Not found property with UID e3ddcd1a-0e3e-4649-91be-c59d7b50. Please re-sync the list of user's properties"
  ]
}