MIDAS API
Available in API 2.0+

mod_booking

Modifies an existing booking
Required ParametersPossible ValuesDescription
idBooking IDThe unique numeric ID of the booking to be modified
In addition, one or more of the parameters from the following table must also be included with the call. Only values for the parameters you specify will be changed. For example, to only change a booking type, whilst retaining the booking's original start, end, and venue details, only pass the "new_type" parameter. To change the venue and the type and the venue, pass both "new_type" and "new_venue".
Optional Parameters
(One or more required)
Possible ValuesDescription
new_startValid date and time
(Format: YYYYMMDDHHMM)
The new start date/time the booking should be changed to
new_endValid date and time
(Format: YYYYMMDDHHMM)
The new end date/time the booking should be changed to
new_venueVenue ID | Venue NameThe numeric ID or name of the venue the booking should be changed to
new_clientClient IDThe numeric ID of the client the booking should be changed to
new_typeType ID | Type NameThe numeric ID of the Booking Type, or the name of the Booking Type the booking should be changed to
new_attendeesNumberThe new number of booking attendees
new_notesStringNew notes about the booking
new_resourcesQuantity & Resource ID | Resource NameNew resources to be added to the booking. Values should be passed as "qty|resource (ID or name)".
For example, to add 2 Tables to a booking, pass "2|Tables".
This parameter can be added multiple times to add further resources
Note: Passing the "new_resources" parameter will remove any previous resources that had been assigned to the booking
new_custom fieldsCustom valueIf you've defined custom booking fields in your MIDAS, you can optionally specify new values for these fields for the booking you're modifying.
For example, if you have a custom field named "Insurance", you would pass the parameter "new_insurance" together with the new value you wish to set
Optional ParametersPossible ValuesDescription
accept_limited_resources0 | 1If you're specifying new resources for a booking, this parameter determines whether the bookings should still be modified if the quantity of resources requested isn't available.
For example, if you add 10 Tables to a booking, yet only 5 Tables are available, an error will be returned and the booking won't be modified. However, passing the "accept_limited_resources" parameter with a value of "1" will continue the modify booking, but with reduced resource quantities (in the previous example, this would mean that only 5 Tables would be added to the booking, instead of the desired 10)
no_watches0 | 1Setting the "no_watches" parameter to "1" will suppress generation of Watch notifications for users who are monitoring modified bookings, otherwise omitting this parameter (or setting it to "0") will allow Watch notifications to be generated accordingly
Example Response
{
	"booking_modified":"1"
}
Variables Returned
(on success)
Description
booking_modifiedReturns "1" if the booking was successfully modified
Variables Returned
(on error)
Description
errorThe reason why the booking couldn't be modified. Examples include:
Unavailable (clashes with an existing booking)
Unavailable - Blocked By Meeting Room 1
45 Attendees will exceed the maximum capacity of Meeting Room 1 (15)
Outside Operating Hours
Venue unavailable from 1/1/2015
Venue unavailable between 1/1/2015-1/2/2015
Venue not available until 1/1/2015
Only x5 Tables Available