Developers
Menus8

Update a menu item

PATCH/menus/{menu_key}/items/{menu_item_id}

Updates a menu item. Fields that are omitted keep their current values.

Items cannot be nested or moved to another menu.

Send the ETag returned by the retrieve operation in the If-Match header to avoid overwriting changes made since the item was retrieved.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

menu_key*string

Key of the menu.

menu_item_id*string

Public ID of the menu item, prefixed with mnu_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/menus/string/items/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "destination": {      "embed": "string",      "product_id": "string",      "shortcut": "string",      "showcase_id": "string",      "url": "string"    },    "id": "string",    "kind": "shortcut",    "label": "string",    "object": "menu_item",    "position": 0,    "revision": "string",    "target": "_self",    "visible": true  }}

Retrieve a menu item GET

Retrieves a menu item by its public ID. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the menu item to avoid overwriting a newer version.

Delete a menu item DELETE

Deletes a menu item and removes it from the menu.