CampaignSettings Metadata Type in SFDX & Metadata API

Architectural Overview#

The CampaignSettings metadata type governs org-wide behavior for Salesforce Campaigns, Marketing Attribution, and Account Engagement (Pardot) campaign features. From an architectural standpoint, CampaignSettings is a critical foundation artifact in CI/CD pipelines: until <enableCampaignInfluence2>true</enableCampaignInfluence2> is deployed in Campaign.settings-meta.xml, the standard CampaignInfluence and CampaignInfluenceModel SObjects remain hidden in the target org’s schema, causing any dependent CampaignInfluenceModel, Apex classes, Flows, or custom report types to fail compilation.

In addition to unlocking Customizable Campaign Influence, CampaignSettings defines the org’s automatic campaign influence association window (autoAssociationSettings) and Einstein Campaign Insights (enableCampaignInsights).

SFDX Directory & File Suffix#

Key Metadata Fields#

The CampaignSettings metadata type exposes the following configuration fields:

Declarative XML & package.xml Examples#

SFDX Source File Example#

<?xml version="1.0" encoding="UTF-8"?>
<CampaignSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAccountsAsCM>true</enableAccountsAsCM>
    <enableCampaignHistoryTrack>true</enableCampaignHistoryTrack>
    <enableCampaignInfluence2>true</enableCampaignInfluence2>
    <enableCampaignInsights>false</enableCampaignInsights>
</CampaignSettings>

Package Manifest (package.xml)#

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

Scratch Org Definition (project-scratch-def.json)#

{
  "orgName": "RevOps Attribution Scratch Org",
  "edition": "Enterprise",
  "features": ["PardotScFeaturesCampaignInfluence"],
  "settings": {
    "campaignSettings": {
      "enableAccountsAsCM": true,
      "enableCampaignHistoryTrack": true,
      "enableCampaignInfluence2": true
    }
  }
}

SFDX CLI Retrieval & Deployment Commands#

Retrieve and deploy CampaignSettings using the Settings:Campaign component name:

# Retrieve CampaignSettings from an org
sf project retrieve start --metadata Settings:Campaign

# Deploy CampaignSettings to enable Customizable Campaign Influence
sf project deploy start --metadata Settings:Campaign

Senior Architect Best Practices & Gotchas#

• Scratch Org Feature Requirement for enableCampaignInfluence2: In scratch org builds, setting enableCampaignInfluence2: true requires the "PardotScFeaturesCampaignInfluence" or "CampaignInfluence2" feature in project-scratch-def.json and the CampaignInfluence2 user permission on the running user.
• Marketing User Checkbox Dependency: Users deploying or configuring Campaign settings and records often require the standard Marketing User (UserPermissionsMarketingUser = true) checkbox enabled on their User record in addition to profile or PermissionSet CRUD access on Campaign.
• Stage Deployment Before Attribution Code: If your repository contains Apex classes querying CampaignInfluence and Campaign.settings-meta.xml in a brand-new org, deploy Settings:Campaign first (or ensure campaignSettings is set in project-scratch-def.json) so the CampaignInfluence SObject exists before Apex compilation runs.

Frequently asked questions

What does CampaignSettings control in Salesforce?

It manages org-wide Campaign configuration, including enabling Customizable Campaign Influence, setting automatic campaign-to-opportunity association timeframes, and toggling Einstein Campaign Insights.

Where is CampaignSettings stored in SFDX source format?

It is stored at force-app/main/default/settings/Campaign.settings-meta.xml in SFDX source format.

What does the enableCampaignInfluence2 flag do?

Setting enableCampaignInfluence2 to true activates Customizable Campaign Influence, exposing the CampaignInfluenceModel and CampaignInfluence objects in the org.

How do I retrieve CampaignSettings in package.xml?

Use the Settings metadata type name and specify Campaign inside the members tag.