Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

EmbeddedServiceConfig

Represents a setup node for creating a Snap-ins deployment. Available in API version 38.0 and later.

Supported Calls

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

Supported REST HTTP Methods

GET, POST, PATCH, DELETE

Fields

Field	Details
AreGuestUsersAllowed	Type boolean Properties Defaulted on Create, Filter, Group, Sort Description Specifies whether a user must be logged in to access a Snap-in. Available in API version 45.0 and later.
AuthMethod	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of login method selected for this Snap-ins deployment. Valid values are: `CommunitiesLogin` `CustomLogin` Available in API version 43.0 and later.
CustomMinimizedComponentId	Type reference Properties Filter, Group, Nillable, Sort Description The custom Lightning component that’s used for the minimized snap-in for this Snap-ins Chat deployment. Available in API version 43.0 and later.
DeveloperName	Type string Properties Filter, Group, Sort Description Unique name for the embedded service configuration setup node.
FullName	Type string Properties Create, Group, Nillable Description The unique name used for this Snap-ins deployment. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. 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.
Language	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Languages supported in the snap-in deployment. Chinese (Simplified): `zh_CN` Chinese (Traditional): `zh_TW` Danish: `da` Dutch: `nl_NL` English: `en_US` Finnish: `fi` French: `fr` German: `de` Italian: `it` Japanese: `ja` Korean: `ko` Norwegian: `no` Portuguese (Brazil): `pt_BR` Russian: `ru` Spanish: `es` Spanish (Mexico): `es_MX` Swedish: `sv` Thai: `th`
ManageableState	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` `installed` `released` `unmanaged` For more information about states of manageability for components in Salesforce AppExchange packages, see “Planning the Release of Managed Packages” in the Salesforce online help.
MasterLabel	Type string Properties Filter, Group, Sort Description Name of the embedded service configuration node.
Metadata	Type `mns:`EmbeddedServiceConfig Properties Create, Nillable, Update Description The Snap-ins configuration 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 associated with this object. Each Developer Edition organization 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 organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if 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 organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
ShouldHideAuthDialog	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the prompt that the customer login again during a flow is hidden (`true`) or not (`false`). When it’s hidden, the customer is taken directly to your login page. This field is set to `false` by default. Available in API version 43.0 and later.