PardotSettings

Represents Marketing Cloud Account Engagement settings in your Salesforce org. Account Engagement, formerly known as Pardot, is a B2B marketing automation solution that helps you create meaningful connections, generate more pipeline, and close more deals. Use these settings to configure how Account Engagement collects and displays data.

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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

This object is stored in a file named Pardot.Settings in the settings folder of the corresponding package directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version 

Introduced in API version 47.0.

Special Access Rules 

This metadata type is available only to orgs with Account Engagement.

Fields 

cdpEnablementStatus 

  • Type: string
  • Required: No
  • Description: The status of the enablement in for the account engagement business unit.

enableAeDataConnector 

  • Type: boolean
  • Required: No
  • Description: Enable the Account Engagement Connector for creating Account Engagement Data Streams.

enableAIEinsteinEngageFreq 

  • Type: boolean
  • Required: No

enableAIOptimizedSendTime 

  • Type: boolean
  • Required: No
  • Description: Enable Einstein Send Time Optimization for sending Account Engagement emails.

enableB2bmaAppEnabled 

  • Type: boolean
  • Required: No
  • Description: Deprecated.

enableEngagementHistoryDashboards 

  • Type: boolean
  • Required: No
  • Description: Enable the Engagement History Dashboard and allow related Account Engagement data to be shared to campaign records in Salesforce by setting this value to true. The default value is false. If enableEnagementHistoryDashboards is disabled after being enabled, the Engagement History Dashboard is removed, but engagement data continues to be retained and updated.

enableEnhancedProspectCustomFieldsSync 

  • Type: boolean
  • Required: No
  • Introduced: API version 52.0
  • Description: Enable Object Sync to enhance with B2B Marketing Analytics or B2B Marketing Analytics Plus by setting this property to true. The default value is false.

enablePardotAppV1Enabled 

  • Type: boolean
  • Required: No
  • Description: Enable the Account Engagement Lightning App by setting this property to true. The default value is false.

enablePardotEnabled 

  • Type: boolean
  • Required: No
  • Description: Deprecated.

enablePardotObjectSync 

  • Type: boolean
  • Required: No
  • Description: Deprecated.

enableProspectActivityDataset 

  • Type: boolean

  • Required: No

  • Description: Enable the Prospect and Activity Dataset for B2B Marketing Automation apps by setting this property to true. When enableProspectActivityDataset is true, the datasets take some time to populate. Depending on how much data and the type of licenses you have, enabling this preference can impact the account’s row limit for Analytics.

    If enableProspectActivityDataset is disabled after being enabled:

    • The data that makes up the datasets is deleted.
    • The Prospect and Activity Dataset in existing B2B Marketing Automation apps stops getting updates.
    • The dataset isn’t available to add to new apps.
    • When apps are reconfigured, the dataset is deleted.

    Requires that enableEnagementHistoryDashboards is set to true.

enableUnifiedEngagementHistoryDashboards 

  • Type: boolean
  • Required: No

PardotEngageFreqSetting 

  • Type: boolean
  • Required: No
  • Description: Enable Einstein Engagement Frequency for sending Account Engagement emails.

Declarative Metadata Sample Definition 

The following is an example of a PardotSettings component.

11 <?xml version="1.0" encoding="UTF-8"?>
22 <PardotSettings xmlns="http://soap.sforce.com/2006/04/metadata">
33     <enablePardotEnabled>true</enablePardotEnabled>
44     <enablePardotAppV1Enabled>true</enablePardotAppV1Enabled>
55     <enableB2bmaAppEnabled>true</enableB2bmaAppEnabled>
66     <enableEngagementHistoryDashboards>true</enableEngagementHistoryDashboards>
77     <enableEnhancedProspectCustomFieldsSync>true</enableEnhancedProspectCustomFieldsSync>
88     <enablePardotObjectSync>true</enablePardotObjectSync>
99     <enableProspectActivityDataset>true</enableProspectActivityDataset>
1010     <enableAIOptimizedSendTime>true</enableAIOptimizedSendTime>
1111 </PardotSettings>

The following is an example package.xml that references the previous definition.

11 <?xml version="1.0" encoding="UTF-8"?>
22 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
33     <types>
44         <members>Pardot</members>
55         <name>Settings</name>
66     </types>
77     <version>47</version>
88 </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.