v1Resources/Locations/putReplace a location menu

Replace a location menu

Replaces the complete menu tree. Omitted sections and items are removed; omitted description is cleared and currency defaults to USD. Read the menu first and include all content to retain.

put/api/v1/location-menus/{id}
locations:write
Query parameters
idstringrequired
Menu ID from the menu list.
Request body
namestringrequired
descriptionstringoptional
currencystringoptional
sectionsarray of objectoptional
Ordered sections, up to 50, with up to 200 items per section and 1,000 items overall.
namestringrequired
descriptionstringoptional
itemsarray of objectoptional
namestringrequired
descriptionstringoptional
pricenumberoptional
caloriesintegeroptional
allergensstringoptional
ingredientsstringoptional
photoKeysarray of stringoptional
Accessible asset keys such as upload:abc, up to 20 per item. Raw image URLs are not accepted.
Response
dataobjectoptional
menuobjectoptional
idstringoptional
namestringoptional
descriptionstringoptional
currencystringoptional
clientIdstringoptional
clientNamestringoptional
sectionsCountintegeroptional
itemsCountintegeroptional
assignedLocationsintegeroptional
createdAtstringoptional
sectionsarray of objectoptional
idstringoptional
namestringoptional
descriptionstringoptional
itemsarray of objectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
422One or more targets are not active restaurant locations of this menu’s client.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The menu operation could not be completed.
put/api/v1/location-menus/{id}
Your API key
id *
Request body*
{}

Guides that use this resource