Skip to main content
PUT
Update Menu

Update Menu

Updates an existing navigation menu. Only the fields you supply are changed; everything else is left intact. The request body may be sent flat or wrapped in a menu object.

Request

Path Parameters

string
required
The unique menu ID (UUID) to update

Body Parameters

All parameters are optional. Only provided fields are updated. Fields may be sent flat (as below) or nested under a top-level menu object.
string
Menu name
string
URL-safe handle
string
URL-safe slug
string
Destination URL for this menu item
string
Where the menu is used (e.g. header, footer)
string
Item resource type (e.g. page, product, category, customized)
array
Array of nested child menu-item objects (stored as JSON)
boolean
Whether the menu item is enabled
integer
Nesting depth (0 for top level)
integer
Sort order within its level
string
Parent menu ID, or null for a top-level item
string
Linked product ID, when menuItemType is product
string
Linked category ID, when menuItemType is category
string
Linked page ID, when menuItemType is page

Response

Returns the standard envelope (status, state, message, data, count, pagination) with the updated menu nested under data.menu.

Example Response

Error Response

When the menu does not exist, the endpoint returns the standard envelope with an error state:

Notes

  • Changing the handle may affect theme templates that reference menus by handle.

Error Codes