---
schema_version: "1"
id: 9de2a77c93de4035b0cce01facb2c438e56f516828d1fa76921e7b60268e9439
title: NavigationMenuItem
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_navigationmenuitem.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_navigationmenuitem.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 636286ddb709203510349806e37e00eda97a2e567919d4abdb4fea6926ca79ae
description: Represents a single menu item in a NavigationLinkSet. Use this object to create, delete, or update menu items in your Experience Cloud site’s navigation menu. This object is available in API version 35.0 and later.
---
# NavigationMenuItem

Represents a single menu item in a NavigationLinkSet. Use this object to create, delete, or update menu items in your Experience Cloud site’s navigation menu. This object is available in API version 35.0 and later.

## Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

## Special Access Rules

Navigation menus are available only in Experience Cloud sites created using Experience Builder templates. To use navigation menus in LWR templates, you must build a custom navigation menu component.

## Fields

| Field Name | Details |
| --- | --- |
| AccessRestriction | 
Type

picklist

Properties

Create, Filter, Group, Restricted picklist, Sort, Update

Description

Determines if the menu item is available to guest users who aren’t required to log in to the Experience Cloud site.



 |
| DefaultListViewId | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

If the value of the Type field is SalesforceObject, the value is the ID of the default list view for the object.



 |
| DraftRowID | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort

Description

The ID of the draft navigation menu item. The ID is unique within your organization.



 |
| Label | 

Type

string

Properties

Create, Filter, Group, Sort, Update

Description

The text that appears in the navigation menu for this item.



 |
| NavigationLinkSetId | 

Type

reference

Properties

Create, Filter, Group, Sort, Update

Description

The navigation menu that this item is included in.



 |
| ParentId | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The parent navigation menu.



 |
| Position | 

Type

int

Properties

Create, Filter, Group, Sort, Update

Description

The location of the menu item in the navigation menu.



 |
| Status | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort

Description

Represents if the navigation menu item is published or not. The values can only be DRAFT, LIVE, or null. In API versions 42 and earlier, if the Status field is not set, the field defaults to LIVE. When queried and Status is not part of the query filter, only the NavigationMenuItem objects with a status of LIVE return. In API versions 43 and later, if the Status field is not set, the field defaults to DRAFT. When queried and Status is not part of the query filter, all NavigationMenuItem objects return regardless of status.



 |
| Target | 

Type

string

Properties

Create, Filter, Group, Sort, Update

Description

If Type is ExternalLink or InternalLink, the target is the URL that the link points to. For ExternalLink, your entry looks like this: https://salesforce.com. For InternalLink, use a relative URL, such as /contactsupport.



 |
| TargetPrefs | 

Type

picklist

Properties

Create, Filter, Group, Restricted picklist, Sort, Update

Description

If Type is ExternalLink, determines whether a navigation menu item opens in the same tab.



 |
| Type | 

Type

picklist

Properties

Create, Filter, Group, Restricted picklist, Sort, Update

Description

The type of navigation menu item. The available values are:

- SalesforceObject—Available objects include accounts, cases, contacts, and custom objects.
- ExternalLink—Links to a URL outside of your Experience Cloud site. For example, https://salesforce.com.
- Event—An event, such as logging in, logging out, or switching accounts. Event is internal only and can’t be used in custom components.
- GlobalAction—Enables users to create object records, but the new record has no relationship with other records.
- InternalLink—Links to a relative URL inside your Experience Cloud site. For example, /contactsupport.
- NavigationalTopic—A dropdown list with links to the navigational topics in your Experience Cloud site.
- SystemLink—A system link, such as a link to Experience Builder, Workspaces, or Salesforce setup.





 |

## Usage

You can add up to 20 navigation menu items. You can translate navigation menu items using the Translation Workbench.