update_menu_itemAdmin-only MCP tool.
Change a menu item, or delete it. Only the properties you supply are changed. Use list_menu_items to find menu ids and see what an item has now.
Deleting a menu item removes the link in the user interface only; the form or screen is untouched and is still reachable by anyone whose permissions allow it; only this route to it goes away.
| Property | Type | Required? | Description |
|---|---|---|---|
| menu_id | integer | Required | Required. The menu item to change. Use list_menu_items to find menu ids. |
| link_text | string | Optional | Optional. Leave it out to keep what the item has now. The words people see in the menu. |
| target | object | Optional | Optional. Leave it out to keep what the item has now. Where the item goes. Give exactly one of form_id, screen_id or url. |
| form_id | integer | Optional | Go to this form, showing the user the default list screen, or the default form screen if the user can only interact with a single entry in the form. |
| screen_id | integer | Optional | Go to this particular screen. Use this rather than form_id when a form has several screens and the menu should lead to a specific one. Use list_screens to find screen ids. |
| url | string | Optional | Go to an address instead of a form or screen. A full address for somewhere outside this site, or one beginning with “/” for a page within it. |
| groups_that_can_see | array of integer | Optional | Optional. Leave it out to keep what the item has now. The groups this item is shown to. groups_that_can_see and groups_using_as_start_page are replaced by what you supply, not added to, so send the complete list every time. Leave the property out to keep the item’s current groups. Groups generated from the entries in a form cannot be given menu permissions directly. Instead, give the form-based template group visibility over the menu item. The form-based entry groups will inherit the menu visibility from their corresponding template group. |
| groups_using_as_start_page | array of integer | Optional | Optional. Leave it out to keep what the item has now. The groups that land on this item when they log in. Every group named here must also be in groups_that_can_see, since a person cannot start on a page they are not shown. Where somebody belongs to several groups with different start pages, the one highest in the menu order wins. |
| note | string | Optional | Optional. Leave it out to keep what the item has now. Supply an empty string to clear it. A reminder for whoever maintains this menu. Not shown to anyone using the site. |
| delete | boolean | Optional | Optional. Set true to delete this menu item. Nothing else is needed, and any other properties supplied are ignored. |