Latest News: MIDAS v4.30 Out Now | Refer-a-Friend | We Stand With Ukraine

MIDAS API Addon MIDAS API: mod_venue

Available in API 2.51+
Modifies an existing venue.
Required ParametersPossible ValuesDescription
venueVenue ID/NameThe name or numerical ID of the existing venue to modify
Required Parameters
(at least 1 required)
Possible ValuesDescription
new_nameStringThe new name for the existing venue
new_descriptionStringThe new description for the existing venue (may include HTML)
new_capacityIntegerThe new capacity (maximum occupancy) of the venue
new_closed_allStringSets the periods during all days of the week during which the venue is "closed". Values are all in 24 hour clock mode, in the format HHMM.
To "close" the venue between 11am and 2.30pm, set "new_closed_all" to "11001430".
To set multiple closed periods, add these on to the string. For example, to close a venue between 11am and 2.30pm and 5pm - 6pm, set "1100143017001800".
new_closed_monStringAs "new_closed_all" but applies to Mondays only
new_closed_tueStringAs "new_closed_all" but applies to Tuesdays only
new_closed_wedStringAs "new_closed_all" but applies to Wednesdays only
new_closed_thuStringAs "new_closed_all" but applies to Thursdays only
new_closed_friStringAs "new_closed_all" but applies to Fridays only
new_closed_satStringAs "new_closed_all" but applies to Saturdays only
new_closed_sunStringAs "new_closed_all" but applies to Sundays only
new_rate_allDecimalSets a new venue rate for all days (use in conjunction with the "new_rate_all_type" parameter)
new_rate_monDecimalSets a new venue rate for Mondays (use in conjunction with the "new_rate_mon_type" parameter)
new_rate_tueDecimalSets a new venue rate for Tuesdays (use in conjunction with the "new_rate_tue_type" parameter)
new_rate_wedDecimalSets a new venue rate for Wednesdays (use in conjunction with the "new_rate_wed_type" parameter)
new_rate_thuDecimalSets a new venue rate for Thursdays (use in conjunction with the "new_rate_thu_type" parameter)
new_rate_friDecimalSets a new venue rate for Fridays (use in conjunction with the "new_rate_fri_type" parameter)
new_rate_satDecimalSets a new venue rate for Saturdays (use in conjunction with the "new_rate_sat_type" parameter)
new_rate_sunDecimalSets a new venue rate for Sundays (use in conjunction with the "new_rate_sun_type" parameter)
new_rate_all_typeD | H | F | PSets the type of venue rate being defined (use in conjunction with the "new_rate_all" parameter). Possible options are "D" (Per day), "H" (Per hour), "F" (Fixed), or "P" (Per person)
new_rate_mon_typeStringAs "new_rate_all_type" but applies to Mondays only (use in conjunction with the "new_rate_mon" parameter)
new_rate_tue_typeStringAs "new_rate_all_type" but applies to Tuesdays only (use in conjunction with the "new_rate_tue" parameter)
new_rate_wed_typeStringAs "new_rate_all_type" but applies to Wednesdays only (use in conjunction with the "new_rate_wed" parameter)
new_rate_thu_typeStringAs "new_rate_all_type" but applies to Thursdays only (use in conjunction with the "new_rate_thu" parameter)
new_rate_fri_typeStringAs "new_rate_all_type" but applies to Fridays only (use in conjunction with the "new_rate_fri" parameter)
new_rate_sat_typeStringAs "new_rate_all_type" but applies to Saturdays only (use in conjunction with the "new_rate_sat" parameter)
new_rate_sun_typeStringAs "new_rate_all_type" but applies to Sundays only (use in conjunction with the "new_rate_sun" parameter)
new_taxDecimalSets a new (percentage) tax rate for charges for this venue
new_public0 | 1Sets whether the venue should be available for public booking/requesting
new_colorRRGGBBA hexadecimal color that the venue should appear in in the booking grid
new_closedComma separated listA comma separated list of date ranges during which the venue is "closed". Values are either in the format YYYYMMDD-YYYYMMDD or epoch-epoch times.
Examples:
"20220601-20220614" (Venue closed 1-14 June 2022 (inclusive))
"20220601-" (Venue closed from 1 June 2022 onwards)
"-20220601" (Venue closed until 1 June 2022)
"20220601-20220607,20220614-20220620" (Venue closed 1-7 and 14-20 June 2022 (inclusive))
new_managersComma separated listA comma separated list of numeric user IDs to assign as the "managers" of the venue
new_blocksComma separated listA comma separated list of numeric venue IDs to prevent (block) from being able to be booked at the same time as the venue being modified
new_alternativesComma separated listA comma separated list of numeric venue IDs to offer as suitable alternative venues in the event of unavailability for the venue being modified
Omitting any of the above parameters will leave its current value unchanged. Passing any of the above parameters with a "blank" value will clear/delete the current value of the corresponding field.
Example Response
{
	"venue_modified":"6"
}
Variables ReturnedDescription
venue_modifiedThe unique internal ID corresponding the modified venue