MIDAS API
Available in API 2.0+

del_bookings

Deletes multiple bookings across a date range.
Required ParametersPossible ValuesDescription
startValid date and time
(Format: YYYYMMDDHHMM)
Sets the start of the window in which bookings should be deleted
endValid date and time
(Format: YYYYMMDDHHMM)
Sets the end of the window in which bookings should be deleted
Optional ParametersPossible ValuesDescription
clientClient IDLimits deleting bookings to a specific client
venueVenue nameLimits deleting of bookings to a specific venue
typeBooking TypeLimits 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 ParametersPossible ValuesDescription
force0 | 1By 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_watches0 | 1Setting the "no_watches" parameter to "1" will supress 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 ReturnedDescription
bookings_deletedThe number of bookings deleted