--- schema_version: "1" id: b99bc19f052630adf79f5ed2886ff08a39512ec6c7a48ed3d71b76f6d2569d89 title: EmbeddedServiceMenuSettings collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_embeddedservicemenusettings.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_embeddedservicemenusettings.htm source_site: developer.salesforce.com content_type: documentation content_hash: e542f95b6bc035ab6293f2511a05aacc973de916262d64b60b3a0f5e53d9d6c3 description: Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business. This type extends the Metadata metadata type and inherits its fullName field. --- # EmbeddedServiceMenuSettings Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business. This type extends the Metadata metadata type and inherits its fullName field. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## File Suffix and Directory Location EmbeddedServiceMenuSettings components are stored in the developer\_name.EmbeddedServiceMenuSettings folder. ## Version EmbeddedServiceMenuSettings components are available in API version 47.0 and later. ## Fields | Field Name | Field Type | Description | | --- | --- | --- | | branding | string | The developer name of the associated BrandingSet. | | embeddedServiceCustomLabels | [EmbeddedServiceCustomLabel](#embeddedservicecustomlabel_subtype)\[\] | Represents a customized label that appears in the embedded component for a particular channel menu deployment. | | embeddedServiceCustomizations | [EmbeddedServiceCustomization](#EmbeddedServiceCustomization_subtype)\[\] | The customizations used in this Embedded Service deployment. Each customization is associated with a static resource. Available in API version 50.0 and later. | | embeddedServiceMenuItems | [EmbeddedServiceMenuItem](#embeddedservicemenuitem_subtype)\[\] | Represents a channel menu item that lists a way in which customers can contact your business. | | isEnabled | boolean | If true (default), the deployment is enabled. If false, the deployment is disabled. | | masterLabel | string | Required. The name of the channel menu deployment. | | site | string | Required. The name of the Experience site or website connected to this channel menu deployment. | ## EmbeddedServiceCustomLabel Represents the custom labels used in your channel menu deployment. | Field Name | Field Type | Description | | --- | --- | --- | | customLabel | string | The customized label that appears in the channel menu. | | feature | EmbeddedServiceFeature ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | The feature using the custom label. For channel menu deployments, the value is ChannelMenu. | | labelKey | EmbeddedServiceLabelKey ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | The type of label for this embedded component. The value corresponds to the label within a label group (substate of chat state or page type). | ## EmbeddedServiceCustomization Returns the customization associated with the Embedded Service feature. Available in API version 50.0 and later. | Field Name | Field Type | Description | | --- | --- | --- | | customizationName | string | Required. The name of the customization applied to the embedded service. This name can contain only underscores and alphanumeric characters and must be unique in an EmbeddedServiceConfig setup. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. | | description | string | A description of the customization. | | embeddedServiceResources | [EmbeddedServiceResource](#EmbeddedServiceResource_subtype)\[\] | Required. The reference to the static resource that contains the javascript file of the customization. | ## EmbeddedServiceResource Returns the static resource associated with the Embedded Service Chat feature customization. Available in API version 50.0 and later.
Field Name Field Type Description
resource string Required. The ID of the static resource that contains the javascript file of the customization.
resourceType EmbeddedServiceResourceType (enumeration of type string) Required. The embedded service feature to customize. Only the Chat feature is supported. Valid values are:
  • ChatInvitation
## EmbeddedServiceMenuItem Represents an item in a channel menu.
Field Name Field Type Description
channel string The ID of the channel type. If channelType is Phone or CustomURL, this field is null.
channelType EmbeddedServiceChannelType (enumeration of type string) The type of communication channel. Values are:
  • EmbeddedMessaging
  • EmbeddedServiceConfig
  • MessagingChannel
  • Phone
  • CustomURL
customUrl string A custom URL that appears in the menu. The shouldOpenUrlInSameTab field determines where the URL opens.
displayOrder int The item’s order in the menu, such as 1 or 2.
embeddedServiceCustomLabels EmbeddedServiceCustomLabel[] Represents the custom labels used in your channel menu item.
iconUrl string The icon URL for the menu item. Icons can be used only for phone, SMS, custom URL, and chat menu items.
isDisplayedOnPageLoad boolean If true, the menu item is displayed on page load. Available in API version 49.0 and later.
itemName string A unique custom name for the menu item, which is visible in the user interface.
osOptionsHideInIOS boolean If true, the menu item is hidden in iOS.
osOptionsHideInLinuxOS boolean If true, the menu item is hidden in Linux operating system.
osOptionsHideInMacOS boolean If true, the menu item is hidden in Mac operating system.
osOptionsHideInOtherOS boolean If true, the menu item is hidden in any operating system other than iOS, Linux, Mac, and Windows.
osOptionsHideInWindowsOS boolean If true, the menu item is hidden in Windows operating system.
phoneNumber string The phone number for menu items whose channelType is Phone.
shouldOpenUrlInSameTab boolean If the menu item’s channelType is CustomURL, this field indicates whether the link opens in the same tab (true) or a new tab (false).
## Declarative Metadata Sample Definition The following is an example of an EmbeddedServiceMenuSettings component. CM\_Container\_Header\_Primary\_Greeting\_3MsRM0000004CB5\_6181150 CM\_Container\_Header\_Primary\_Greeting CM\_Container\_Header\_Secondary\_Greeting\_3MsRM0000004CB5\_4637097 CM\_Container\_Header\_Secondary\_Greeting Chat EmbeddedServiceConfig 1 CM\_Container\_MenuItems\_WebChatUnavailable\_3miRM0000004CuZ\_8003848 CM\_Container\_MenuItems\_WebChatUnavailable CM\_Container\_MenuItems\_WebChatAvailable\_3miRM0000004CuZ\_5823055 CM\_Container\_MenuItems\_WebChatAvailable Chat1 false true false false true false Phone 2 Phone1 true false true false false 1234567890 false CustomURL https://google.com 3 url1 false false false false false false true ChannelMenuSettings SnapInCommunity ## Wildcard Support in the Manifest File This metadata type doesn’t support the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).