EmbeddedServiceMenuSettings | Tooling API

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.

Important

Supported SOAP API Calls

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

Supported REST API Methods

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
BrandingId	Type reference Properties Filter, Group, Nillable, Sort Description The developer name of the associated BrandingSet.
DeveloperName	Type string Properties Filter, Group, Sort Description The unique name for the embedded service menu settings. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated EmbeddedServiceMenuSettings in Metadata API. The full name can include a namespaceprefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IsEnabled	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the channel menu is deployed (`true`) or not (`false`).
Language	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the embedded service menu. Possible values are: `ar`—Arabic `da`—Danish `de`—German `en_US`—English `es`—Spanish `fi`—Finnish `fr`—French `iw`—Hebrew `ja`—Japanese `ko`—Korean `nl_BE`—Dutch (Belgium) `no`—Norwegian `pt_BR`—Portuguese (Brazil) `ru`—Russian `sv`—Swedish `th`—Thai `ur`—Urdu `zh_CN`—Chinese (Simplified) `zh_TW`—Chinese (Traditional)
ManageableState	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
MasterLabel	Type string Properties Filter, Group, Sort Description Label for the embedded service menu setting. In the UI, this field is Channel Menu Deployment Name.
Metadata	Type EmbeddedServiceMenuSettings Properties Create, Nillable, Update Description The EmbeddedServiceMenuSettings's metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

Usage

An EmbeddedServiceMenuSettings record creates a channel menu. A channel menu lists the ways in which customers can contact your business. A channel is created using EmbeddedServiceMenuItem and is a child record of EmbeddedServiceMenuSettings. Here you can specify the Site name, BrandingSet name, and whether the channel menu is deployed or not. The Site field is not exposed in the Tooling API but you can edit it using the following Metadata block.

1{
2    "FullName" : "embeddedServiceMenuSettingsName",
3    "Metadata" : {
4        "branding" : "brandingSetRecordDevName",
5        "isEnabled" : true,
6        "masterLabel" : "embeddedServiceMenuSettingsName",
7        "site" : "siteRecordDevName"
8    }
9}