EmbeddedServiceMenuItem

Represents the information needed to configure a Channel Menu item.

Version 

Introduced in API version 47.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• DELETE, GET, HEAD, PATCH, POST, Query
• 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 

ChannelId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: The unique ID of an EmbeddedServiceConfig (the Embedded Service deployment) if ChannelType is one of the following. Otherwise, this field is null.

• EmbeddedServiceConfig

• MessagingChannel

• Relationship name: Channel

• Relationship type: polymorphic

• Refers to: EmbeddedServiceConfig, MessagingChannel

ChannelType 

• Type: picklist

• Required: No

• Properties: Create, Filter, Group, Restricted picklist, Sort, Update

• Description: The channel the customer uses to contact your business.

• Possible values:

  • EmbeddedServiceConfig — EmbeddedServiceConfig

  • MessagingChannel — MessagingChannel

  • Phone — Phone

  • CustomURL — CustomURL

  • EmbeddedMessaging — EmbeddedMessaging

CustomUrl 

• Type: url

• Required: No

• Properties: Create, Filter, Nillable, Sort, Update

• Introduced: API version 48.0

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

DisplayOrder 

• Type: int

• Required: No

• 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

• Required: No

• Properties: Create, Filter, Group, Sort

• Description: Required. The unique ID of the parent record EmbeddedServiceMenuSettings.

• Relationship name: EmbeddedServiceMenu

• Relationship type: masterdetail

• Refers to: EmbeddedServiceMenuSettings

IconUrl 

• Type: url

• Required: No

• Properties: Create, Filter, Nillable, Sort, Update

• Introduced: API version 48.0

• Description: The URL of the icon used for the menu item.

IsDisplayedOnPageLoad 

• Type: boolean

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Introduced: API version 49.0

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

• Default value: false

ItemName 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Introduced: API version 48.0

• 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

• Required: No

• Properties: Create, Filter, Update

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

OsOptionsHideInLinuxOS 

• Type: boolean

• Required: No

• Properties: Create, Filter, Update

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

OsOptionsHideInMacOS 

• Type: boolean

• Required: No

• Properties: Create, Filter, Update

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

OsOptionsHideInOtherOS 

• Type: boolean

• Required: No

• 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

• Required: No

• Properties: Create, Filter, Update

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

PhoneNumber 

• Type: phone

• Required: No

• 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

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Introduced: API version 48.0

• 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.

• Default value: false

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 record, which can have one or more EmbeddedServiceMenuItem objects associated with it.