---
schema_version: "1"
id: 6f6ba13c548c734b3065ef728170a17891a009dc1a6f796ef64004159506e206
title: EmbeddedServiceMenuItem
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_embeddedservicemenuitem.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_embeddedservicemenuitem.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 70de9f51502fe99fb01023ee7516d82a485991564f1638f774019bc5f64c364f
description: Represents the information needed to configure a Channel Menu item. This object is available in API version 47.0 and later.
---
# EmbeddedServiceMenuItem

Represents the information needed to configure a Channel Menu item. This object is available in API version 47.0 and later.

## Supported SOAP API Calls

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

## Special Access Rules

DELETE, GET, HEAD, PATCH, POST, Query

## Special Access Rules

This type is available only if Salesforce Experiences and Salesforce Sites are enabled in your org. To access this type, you need the Customize Application user permission.

## Fields

| Field | Details |
| --- | --- |
| ChannelId | 
Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The unique ID of an [EmbeddedServiceConfig](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_embeddedserviceconfig.htm "Represents a setup node for creating an Embedded Service deployment. Available in API version 38.0 and later.") (the Embedded Service deployment) if ChannelType is one of the following. Otherwise, this field is null.

- EmbeddedServiceConfig
- MessagingChannel





 |
| ChannelType | 

Type

picklist

Properties

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

Description

The channel the customer uses to contact your business. The possible values are:

- CustomURL
- EmbeddedServiceConfig
- MessagingChannel
- Phone





 |
| CustomUrl | 

Type

url

Properties

Create, Filter, Nillable, Sort, Update

Description

The custom URL of the menu item if ChannelType is CustomURL. Otherwise, this field is null.



 |
| DisplayOrder | 

Type

int

Properties

Create, Filter, Group, Sort, Update

Description

The order that the menu items are displayed in the UI. Only positive values are supported.



 |
| EmbeddedServiceMenuId | 

Type

reference

Properties

Create, Filter, Group, Sort

Description

Required. The unique ID of the parent record [EmbeddedServiceMenuSettings](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_embeddedservicemenusettings.htm "Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business. This object is available in API version 47.0 and later.").



 |
| IconUrl | 

Type

url

Properties

Create, Filter, Nillable, Sort, Update

Description

The URL of the icon used for the menu item.



 |
| IsDisplayedOnPageLoad | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

Specifies whether the menu item is dynamically displayed (true) or hidden (false) during runtime. The default value is false.



 |
| ItemName | 

Type

string

Properties

Create, Filter, Group, Sort, Update

Description

The unique name used on the Setup for admins to identify the Channel Menu item. Conforms to the same properties as a developer name.



 |
| OsOptionsHideInIOS | 

Type

boolean

Properties

Create, Filter, Update

Description

Specifies whether to hide the menu item on iOS platforms (true) or not (false).



 |
| OsOptionsHideInLinuxOS | 

Type

boolean

Properties

Create, Filter, Update

Description

Specifies whether to hide the menu item on Linux platforms (true) or not (false).



 |
| OsOptionsHideInMacOS | 

Type

boolean

Properties

Create, Filter, Update

Description

Specifies whether to hide the menu item on macOS platforms (true) or not (false).



 |
| OsOptionsHideInOtherOS | 

Type

boolean

Properties

Create, Filter, Update

Description

Specifies whether to hide the menu item on any other platforms not mentioned here (true) or not (false).



 |
| OsOptionsHideInWindowsOS | 

Type

boolean

Properties

Create, Filter, Update

Description

Specifies whether to hide the menu item on Windows platforms (true) or not (false).



 |
| PhoneNumber | 

Type

phone

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The phone number of menu items with ChannelType value Phone. Otherwise, the value is null.



 |
| ShouldOpenUrlInSameTab | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

Specifies whether a URL is opened in the same tab (true) or not (false). This field only applies for menu items with ChannelType value CustomURL.



 |

## Usage

The EmbeddedServiceMenuItem object provides configuration information for a Channel Menu. A channel menu lists the ways in which customers can contact your business. A channel menu deployment is tied to a [EmbeddedServiceMenuSettings](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_embeddedservicemenusettings.htm "Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business. This object is available in API version 47.0 and later.") record, which can have one or more EmbeddedServiceMenuItem objects associated with it.