| AvatarImg |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- URL of the image used as the agent avatar image.
|
| ContrastInvertedColor |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Accent branding color used in the embedded component, displayed as a hexadecimal
value. Changes made to this field in the API aren’t
reflected in the embedded component.
|
| ContrastPrimaryColor |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Value of the ContrastPrimaryColor
field in the EmbeddedServiceBranding setup object.
|
| CustomMinimizedComponent |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The custom Aura component that’s used for the minimized state for this Embedded Chat
deployment.
|
| CustomPrechatComponent |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The custom Aura component that’s used for the pre-chat page for this Embedded Chat
deployment.
|
| DurableID |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Developer name for the EmbeddedServiceConfig.
|
| FieldServiceConfirmCardImg |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- URL of the image used for the confirmation card in embedded Appointment Management
(beta).
|
| FieldServiceHomeImg |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- URL of the image used for the home screen in embedded Appointment Management
(beta).
|
| FieldServiceLogoImg |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- URL of the logo used for the home screen in embedded Appointment Management
(beta).
|
| Font |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Font used in the chat text of the Embedded Chat window.
|
| FontSize |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Font size for the embedded component.
|
| HeaderBackgroundImg |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- URL of the image used for the header background in Embedded Chat.
|
| Height |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- Height of the embedded component.
|
| IsFieldServiceEnabled |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Specifies whether Field Service is enabled for this Embedded
Service deployment (true) or not (false). Embedded Appointment Management is
currently beta.
|
| IsLiveAgentEnabled |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Specifies whether Chat is enabled for this Embedded Service
deployment (true)
or not (false).
|
| 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).
|
| IsPreChatEnabled |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Value of the PreChatEnabled field
in the EmbeddedServiceLiveAgent setup object.
|
| 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).
|
| NavBarColor |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Value of the NavBarColor field in
the EmbeddedServiceBranding setup object.
|
| OfflineCaseBackgroundImg |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- URL of the image used for the background for the offline support case form in Embedded
Chat.
|
| PrechatBackgroundImg |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- URL of the image used for the background for the pre-chat form in Embedded Chat.
|
| PrimaryColor |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Value of the PrimaryColor field in
the EmbeddedServiceBranding setup object.
|
| SecondaryColor |
- Type
- string
- Properties
- Filter, Group, Nillable
Sort
- Description
- Value of the SecondaryColor field
in the EmbeddedServiceBranding setup object.
|
| ShouldHideAuthDialog |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Specifies whether the prompt that the customer log in
again during a flow should be hidden
(true) or not
(false). When it’s hidden, the
customer is taken directly to your login page.
|
| ShouldShowExistingAppointment |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Specifies whether to display a button on the home screen for customers to access their
existing appointments (true) or not
(false) for embedded
Appointment Management (beta).
|
| ShouldShowNewAppointment |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Specifies whether to display a button on the home screen for customers to create a new
appointment (true) or not
(false) for embedded
Appointment Management (beta).
|
| Site |
- Type
- string
- Properties
- Filter, Group, Nillable
Sort
- Description
- Value of the Site field in the
EmbeddedServiceConfig setup object.
|
| SmallCompanyLogoImg |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- URL of the logo image used with Embedded Chat.
|
| WaitingStateBackgroundImg |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- URL of the image used for the background image in Embedded Chat while the customer
waits to be connected with a support agent.
|
| Width |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- Width of the embedded component.
|
j