{
  "sections": [
    "title",
    "description",
    "fields",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "EmbeddedServiceDetail - Data API",
  "description": "Represents a metadata catalog object that exposes fields from the underlying Embedded Service setup objects defined in each EmbeddedServiceConfig deployment for guest users. Guest users don’t have direct access to the Embedded Service setup objects. Available in API version 39.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "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.Possible values are: Small Medium Large"
    },
    "HeaderBackgroundImg": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "URL of the image used for the header background in Embedded Chat. This field is removed in API version 49.0 and later. The header background image is no longer supported."
    },
    "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."
    },
    "NavBarTextColor": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "This field is used to set the text color for the header."
    },
    "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."
    },
    "SecondaryNavBarColor": {
      "type": "string",
      "properties": "Filter, Group, Nillable Sort",
      "description": "This field is used to set the color of a secondary header."
    },
    "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."
    }
  },
  "wsdl_segment": "```xml\n<complexType name=\"EmbeddedServiceDetail\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"AvatarImg\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ContrastInvertedColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ContrastPrimaryColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CustomMinimizedComponent\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CustomPrechatComponent\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DurableId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FieldServiceConfirmCardImg\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FieldServiceHomeImg\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FieldServiceLogoImg\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Font\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FontSize\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Height\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"IsFieldServiceEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsLiveAgentEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsOfflineCaseEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsPrechatEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsQueuePositionEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"NavBarColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NavBarTextColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OfflineCaseBackgroundImg\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PrechatBackgroundImg\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PrimaryColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SecondaryColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SecondaryNavBarColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ShouldHideAuthDialog\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"ShouldShowExistingAppointment\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"ShouldShowNewAppointment\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Site\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SmallCompanyLogoImg\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"WaitingStateBackgroundImg\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Width\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n```",
  "field_reference": {
    "AvatarImg": {
      "field_label": "Avatar Image URL",
      "type": "string",
      "length": "255"
    },
    "ContrastInvertedColor": {
      "field_label": "Contrast Inverted Color",
      "type": "string",
      "length": "255"
    },
    "ContrastPrimaryColor": {
      "field_label": "Contrast Primary Color",
      "type": "string",
      "length": "255"
    },
    "CustomMinimizedComponent": {
      "field_label": "Custom Minimized Component Developer Name",
      "type": "string",
      "length": "18"
    },
    "CustomPrechatComponent": {
      "field_label": "Custom Prechat Component Developer Name",
      "type": "string",
      "length": "18"
    },
    "DurableId": {
      "field_label": "Embedded Service Durable ID",
      "type": "string",
      "length": "255"
    },
    "FieldServiceConfirmCardImg": {
      "field_label": "Field Service Confirmation Card Image URL",
      "type": "string",
      "length": "255"
    },
    "FieldServiceHomeImg": {
      "field_label": "Field Service Home Image URL",
      "type": "string",
      "length": "255"
    },
    "FieldServiceLogoImg": {
      "field_label": "Field Service Logo Image URL",
      "type": "string",
      "length": "255"
    },
    "Font": {
      "field_label": "Font",
      "type": "string",
      "length": "255"
    },
    "FontSize": {
      "field_label": "Font Size",
      "type": "picklist",
      "length": "255"
    },
    "Height": {
      "field_label": "Height",
      "type": "int",
      "digits": "9"
    },
    "Id": {
      "field_label": "Embedded Service ID",
      "type": "id",
      "length": "18"
    },
    "IsFieldServiceEnabled": {
      "field_label": "Enabled",
      "type": "boolean"
    },
    "IsLiveAgentEnabled": {
      "field_label": "Enabled",
      "type": "boolean"
    },
    "IsOfflineCaseEnabled": {
      "field_label": "Offline Case Enabled",
      "type": "boolean"
    },
    "IsPrechatEnabled": {
      "field_label": "Pre-Chat Enabled",
      "type": "boolean"
    },
    "IsQueuePositionEnabled": {
      "field_label": "Queue Position Enabled",
      "type": "boolean"
    },
    "NavBarColor": {
      "field_label": "NavBar Color",
      "type": "string",
      "length": "255"
    },
    "NavBarTextColor": {
      "field_label": "NavBar Text Color",
      "type": "string",
      "length": "255"
    },
    "OfflineCaseBackgroundImg": {
      "field_label": "Offline Case Background Image URL",
      "type": "string",
      "length": "255"
    },
    "PrechatBackgroundImg": {
      "field_label": "Pre-Chat Background Image URL",
      "type": "string",
      "length": "255"
    },
    "PrimaryColor": {
      "field_label": "Primary Color",
      "type": "string",
      "length": "255"
    },
    "SecondaryColor": {
      "field_label": "Secondary Color",
      "type": "string",
      "length": "255"
    },
    "SecondaryNavBarColor": {
      "field_label": "Secondary NavBar Color",
      "type": "string",
      "length": "255"
    },
    "ShouldHideAuthDialog": {
      "field_label": "Hide Authentication Dialog",
      "type": "boolean"
    },
    "ShouldShowExistingAppointment": {
      "field_label": "Show Existing Appointment",
      "type": "boolean"
    },
    "ShouldShowNewAppointment": {
      "field_label": "Show New Appointment",
      "type": "boolean"
    },
    "Site": {
      "field_label": "Site",
      "type": "string",
      "length": "18"
    },
    "SmallCompanyLogoImg": {
      "field_label": "Small Company Logo Image URL",
      "type": "string",
      "length": "255"
    },
    "WaitingStateBackgroundImg": {
      "field_label": "Waiting State Background Image URL",
      "type": "string",
      "length": "255"
    },
    "Width": {
      "field_label": "Width",
      "type": "int",
      "digits": "9"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}