OpportunityInsightsSettings

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

This metadata type has been deprecated as of API version 59.0.

Note

This type extends the Metadata metadata type and inherits its fullName field.

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

File Suffix and Directory Location

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.

Version

OpportunityInsightsSettings is available in API versions 48.0 to 58.0.

Fields

Field Name Field Type Description
enableOpportunityInsights boolean Indicates whether Einstein Opportunity Insights is enabled (true) or not (false). The default value is false.

Declarative Metadata Sample Definition

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

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

Example Package Manifest

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

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

Wildcard Support in the Manifest File

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.