ObjectLinkingSettings (Beta)

Represents the channel-object linking settings for an org. This type extends the Metadata metadata type and inherits its fullName field.

As a beta feature, Channel-Object Linking is a preview and isn’t part of the “Services” under your Main Services Agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature. For information on enabling this feature, contact Salesforce.

Note

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

File Suffix and Directory Location

ObjectLinkingSettings values are stored in the ObjectLinking.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

ObjectLinkingSettings components are available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
enableObjectLinking	boolean	Indicates whether Channel-Object Linking is enabled, allowing you to link channel interactions to objects such as Contacts. The default value is `false`.

Declarative Metadata Sample Definition

The following is an example of an ObjectLinkingSettings component.

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

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

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

Metadata API Developer Guide

ObjectLinkingSettings (Beta)

File Suffix and Directory Location

Version

Fields

Declarative Metadata Sample Definition