Available in API 2.0+
Deletes multiple bookings across a date range.
Required Parameters | Possible Values | Description |
start | Valid date and time (Format: YYYYMMDDHHMM) | Sets the start of the window in which bookings should be deleted |
end | Valid date and time (Format: YYYYMMDDHHMM) | Sets the end of the window in which bookings should be deleted |
Optional Parameters | Possible Values | Description |
client | Client ID | Limits deleting bookings to a specific client |
venue | Venue name | Limits deleting of bookings to a specific venue |
type | Booking Type | Limits deleting of bookings to a specific booking type |
Any combination of the above optional parameters may be used to limit which bookings are deleted. For example, specifying both a client and a venue will only delete bookings which match BOTH criteria.
Optional Parameters | Possible Values | Description |
force | 0 | 1 | By default, when a booking is "deleted", it still persists in a "hidden" state (allowing it to be restored at a later stage). Passing the "force " parameter with a value of "1" will mean that the booking will be completely removed from the system |
no_watches | 0 | 1 | Setting the "no_watches " parameter to "1 " will suppress generation of Watch notifications for users who are monitoring deleted bookings, otherwise omitting this parameter (or setting it to "0 ") will allow Watch notifications to be generated accordingly |
Example Response |
{
"bookings_deleted":"7"
} |
Variables Returned | Description |
bookings_deleted | The number of bookings deleted |