v1Resources/Locations/postCreate a location menu

Create a location menu

Manage client-owned menus. Requires an active agency user with Clients access. User permissions and credential client restrictions both apply. Menu photos must be accessible to the owning client.

post/api/v1/location-menus
locations:write
Request body
clientIdstringrequired
Client ID or public ID. Optional when listing; omission returns menus across accessible clients.
menuobjectrequired
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.
post/api/v1/location-menus
Your API key
Request body*
{}

Guides that use this resource