IndustriesReferralMarketingSettings

Represents the settings to enable capabilities of Referral Marketing.

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

Parent Type

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

File Suffix and Directory Location

IndustriesReferralMarketingSettings values are stored in a single file named IndustriesReferralMarketing.settings 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

IndustriesReferralMarketingSettings components are available in API version 59.0 and later.

Fields

enableMarketingCloudIntegration

Field Type: boolean

Description: Indicates whether the capability to integrate Referral Marketing with Marketing Cloud is enabled (true) or not (false). The default value is false. This field is available in API version 59.0 and later.

To enable the capability that uses Data Cloud data graphs to query for Data Cloud segments that customers belong to, see the enableSegmentQueryByDataGraph field of the IndustriesLoyaltySettings metadata type in the Loyalty Management Developer Guide.

Tip

Declarative Metadata Sample Definition

The following is an example of a IndustriesReferralMarketingSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<IndustriesReferralMarketingSettings
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<enableMarketingCloudIntegration>false</enableMarketingCloudIntegration>
5</IndustriesReferralMarketing>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<types>
5		<members>IndustriesReferralMarketing</members>
6		<name>Settings</name>
7	</types>
8	<version>59.0</version>
9</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.