--- schema_version: "1" id: 87b13525d14edaadab206f6081ff5c08a5e5de7f5de9f9a83afa5b225227b348 title: EmbeddedServiceLiveAgent collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_embeddedserviceliveagent.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_embeddedserviceliveagent.htm source_site: developer.salesforce.com content_type: documentation content_hash: d2d31c1b90fbc655b94f88fd4b44eb65c819ae4c46756da45a65ef5c6044f2b0 description: Represents a setup node for creating an Embedded Chat deployment. Available in Tooling API version 38.0 and later. --- # EmbeddedServiceLiveAgent Represents a setup node for creating an Embedded Chat deployment. Available in Tooling API version 38.0 and later. ## Supported Calls create(), delete() describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST HTTP Methods DELETE, GET, HEAD, PATCH, POST, PUT, Query ## Special Access Rules To access EmbeddedServiceLiveAgent, your org must have Service Cloud with Chat enabled. ## Fields
Field Details
AvatarImg
Type
url
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used as the agent avatar image. Available in API version 43.0 and later.
CustomPrechatComponent
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Removed. The ID of the custom Lightning Component that’s used for the pre-chat page in this embedded deployment. Available in API versions 38.0 to 45.0. Removed in API version 46.0 and later.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The unique name for the EmbeddedServiceLiveAgent object.
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.
Note

Note

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

Note

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.
EmbeddedServiceConfigId
Type
reference
Properties
Filter, Group, Sort
Description
Unique name for the embedded chat deployment ID.
Enabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this embedded chat deployment is enabled (true). Available in API version 43.0 and later.
FontSize
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Font size for the chat window. Available in API version 43.0 and later.
Possible values are:
  • Small
  • Medium
  • Large
Available in API version 43.0 and later.
FullName
Type
string
Properties
Create, Group, Nillable
Description
The unique name used for this embedded chat 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.
HeaderBackgroundImg
Type
url
Properties
Filter, Group, Nillable, Sort
Description
Removed. URL of the image used for the header background in the embedded chat window. Available in API version 43.0. Removed in API version 49.0 and later.
IsOfflineCaseEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether offline support is enabled for this embedded chat deployment (true) or not (false). Available in API version 43.0 and later.
IsQueuePositionEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether queue position (displaying the customer’s place in line while they wait for an agent) is enabled for this embedded chat deployment (true) or not (false). Available in API version 43.0 and later.
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Languages supported in the embedded chat 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.
LiveAgentChatUrl
Type
url
Properties
Filter, Group, Nillable, Sort
Description
The REST endpoint for Chat. Available in API version 43.0 and later.
LiveAgentContentUrl
Type
url
Properties
Filter, Group, Nillable, Sort
Description
The REST endpoint for Chat content. Available in API version 43.0 and later.
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
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged

Available in API version 43.0 and later.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Name of the embedded chat deployment.
Metadata
Type
mns:EmbeddedServiceLiveAgent
Properties
Create, Nillable, Update
Description
The embedded chat 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.

Available in API version 43.0 and later.
OfflineCaseBackgroundImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used for the background for the offline support case form in an embedded chat window. Available in API version 43.0 and later.
PrechatBackgroundImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used for the background for the pre-chat form in an embedded chat window. Available in API version 43.0 and later.
PreChatEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the pre-chat form is enabled for this embedded chat deployment.
PrechatJson
Type
string
Properties
Nillable
Description
JSON object of all the fields of the selected pre-chat form in Chat setup. Available in API version 43.0 and later.
Scenario
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The type of use case that is selected for the pre-chat form. Valid values are:
  • Basic
  • Sales
  • Service
SmallCompanyLogoImg
Type
url
Properties
Filter, Group, Nillable, Sort
Description
URL of the logo image used with embedded chat. Available in API version 43.0 and later.
WaitingStateBackgroundImg
Type
url
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used for the background image in an embedded chat window while the customer waits to be connected with a support agent. Available in API version 43.0 and later.
## Usage EmbeddedServiceLiveAgent represents a Chat configuration that is added to your web page. The EmbeddedServiceLiveAgent record contains a unique combination of a Chat button and the Chat deployment that the administrator selects during setup. To create an EmbeddedServiceLiveAgent record, create a Chat Deployment, a Chat Button, and an EmbeddedServiceConfig record. Then, set the fields for these records as references on the EmbeddedServiceLiveAgent record.