OpportunityInsightsSettings

Represents an org’s Einstein Opportunity Insights settings. This setting controls features that give you relevant updates about your opportunities.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

This type extends Metadata and inherits its fields.

OpportunityInsightsSettings values are stored in the OpportunityInsights.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

OpportunityInsightsSettings is available in API versions 48.0 to 58.0.

• Type: boolean
• Required: No
• Description: Indicates whether Einstein Opportunity Insights is enabled (true) or not (false). The default value is false.

The following is an example of the OpportunityInsights.settings file:

1<?xml version="1.0" encoding="UTF-8"?>
2<OpportunityInsightsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<enableOpportunityInsights>true</enableOpportunityInsights>
4</OpportunityInsightsSettings>

The following is an example package manifest used to deploy or retrieve the OpportunityInsights settings metadata:

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3	<types>
4 <members>OpportunityInsights</members>
5 <name>Settings</name>
6	</types>
7	<version>29.0</version>
8</Package>

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.