Reference · Menus
Set an online menu tab's pictures
/v1/sites/{siteId}/menus/{code}/tabs/{part}/imageCopies a tab's picture, and the one shown under the cursor, from public URLs into Dnero. Errors with 503 images_unavailable where pictures cannot be stored.
Path
siteIdrequiredThe site, from GET /v1/sites.
string
coderequiredThe menu's code.
string
partrequiredThe tab's or section's code, within the menu.
string
Headers
AuthorizationrequiredAn API key from Automation > Access in the Dnero portal, sent as
Authorization: Bearer <key>.string
Body
cropsquare takes a centred square; original keeps the proportions.
string · one of "square", "original" · default "square"
hoverUrlA public https URL for the picture under the cursor. An empty string removes it.
string · at most 2000 characters
urlA public https URL for the tab's picture. An empty string removes it; leave it out to keep it.
string · at most 2000 characters
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
- images_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