Reference · Menus
Update an online menu
/v1/sites/{siteId}/menus/{code}Renames an online menu, changes the order types it serves, or retires it. Only the fields sent change.
Path
siteIdrequiredThe site, from GET /v1/sites.
string
coderequiredThe menu's code.
string
Headers
AuthorizationrequiredAn API key from Automation > Access in the Dnero portal, sent as
Authorization: Bearer <key>.string
Body
activeFalse to retire it, true to bring it back.
boolean
nameA new name.
string · 1–200 characters
orderTypesReplaces the order types it serves, by code.
array of string
Responses
- bad_requestinvalid_cursoridempotency_key_required
- missing_keyinvalid_keykey_expired+1 more
- key_revokedassistant_keykey_without_access+7 more
- site_not_foundnot_found
- idempotency_key_reusedrequest_in_progress
- invalid_requestnot_a_modifier_group
- rate_limited
- server_error
- upstream_unavailable
200 OK
activerequiredFalse for a retired menu.
boolean
coderequiredThe menu's code.
string
namerequiredThe menu's name, as customers see it.
string
orderrequiredWhere it sits among the site's menus, lowest first.
integer
orderTypesrequiredThe order types it serves, by code: a menu serving none appears nowhere.
array of string
tabsrequiredIts tabs, in order.
array of objects
5 fields in each
coderequiredThe tab's code, within its menu.
string
namerequiredThe tab's name.
string
productsrequiredThe products on the tab, by code, in order.
array of string
hoverImageUrlThe picture shown under the cursor.
string · uri
imageUrlThe tab's picture.
string · uri
updatedAtWhen it last changed.
string · date-time