EmbeddedServiceQuickAction

Returns a quick action that is associated with an EmbeddedServiceLiveAgent setup. The quick action includes the pre-chat form fields that the embedded chat window displays and shows the order in which the fields are displayed.

Version 

Introduced in API version 39.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

EmbeddedServiceLiveAgentId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort

• Description: Reference to the embedded chat deployment.

• Relationship name: EmbeddedServiceLiveAgent

• Relationship type: masterdetail

• Refers to: EmbeddedServiceLiveAgent

Order 

• Type: int

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: Order in which this quick action appears in the embedded chat pre-chat form.

QuickActionDefinitionId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: Reference to a quick action.

• Relationship name: QuickActionDefinition

• Relationship type: relationship

• Refers to: QuickActionDefinition

QuickActionType 

• Type: picklist

• Required: No

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

• Introduced: API version 43.0

• Description: Quick action type. One of the following values:

Available in API version 43.0 and later.

• Possible values:

  • Prechat — Prechat — Pre-chat

  • OfflineCase — OfflineCase — Offline support (Cases)