EmbeddedServiceConfig

Represents a setup node for creating an Embedded Service deployment.

Version 

Introduced in API version 37.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

AreGuestUsersAllowed 

• Type: boolean

• Required: No

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

• Introduced: API version 45.0

• Description: Specifies whether a user must be logged in to access an embedded component.

• Default value: false

AuthMethod 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 43.0

• Description: Type of login method selected for this Embedded Service deployment.

• Possible values:

  • CommunitiesLogin — CommunitiesLogin

  • CustomLogin — CustomLogin

BrandingId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 52.0

• Description: The developer name of the associated BrandingSet. Used only for Embedded Service Deployments of the Messaging type. Used only when DeploymentFeature is EmbeddedMessaging.

• Relationship name: Branding

• Relationship type: relationship

• Refers to: BrandingSet

ClientVersion 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 65.0

• Possible values:

  • WebV1 — WebV1

  • WebV2 — WebV2

DeploymentFeature 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 52.0

• Description: Where the Embedded Service deployment is used. After the value is set, it can’t be updated.

• Possible values:

  • None — None

  • EmbeddedMessaging — EmbeddedMessaging

  • LiveAgent — LiveAgent

  • Flows — Flows

  • FieldService — FieldService

DeploymentType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 51.0

• Description: Set a conversation type for your embedded deployment. This field is available in version 51.0 and later.

• Possible values:

  • Web — Web

  • Mobile — Mobile

  • API — API

  • InternalCopilot — InternalCopilot

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Unique name for the Embedded Service configuration setup node.

  Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

  Note

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 43.0

• Description: The unique name used for this Embedded Service 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.

IsEnabled 

• Type: boolean

• Required: No

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

• Introduced: API version 52.0

• Description: Specifies if the Embedded Service Deployment is enabled for use.

• Default value: false

IsTermsAndConditionsEnabled 

• Type: boolean

• Required: No

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

• Introduced: API version 59.0

• Default value: false

IsTermsAndConditionsRequired 

• Type: boolean

• Required: No

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

• Introduced: API version 59.0

• Default value: false

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: Languages supported in the Embedded Service 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 Spanish (Mexico) defaults to Spanish for customer-defined translations.

• Swedish: sv

• Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• 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

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Name of the embedded service configuration node.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 43.0

• Description: The Embedded Service 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

• Required: No

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

ShouldHideAuthDialog 

• Type: boolean

• Required: No

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

• Introduced: API version 43.0

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

• Default value: false

SiteId 

• Type: ID
• Required: No
• Properties: Filter, Group, Nillable, Sort