AutomatedContactsSettings

Represents an org’s Einstein Automated Contacts settings. These settings let you find new contacts and opportunity contact roles.

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 

AutomatedContactsSettings values are stored in the AutomatedContacts.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 

Introduced in API version 48.0.

Fields 

enableAddContactAutomatically 

  • Type: boolean

  • Required: No

  • Description: Indicates whether new contacts are automatically added from external email accounts (such as Microsoft and Google) to Salesforce (true) or not (false). The default value is false.

    enableAddContactWithSuggestion must be true to use this setting.

When this feature is enabled, users do not see new contacts as suggestions. The contacts are added automatically.

Note

enableAddContactRoleAutomatically 

  • Type: boolean
  • Required: No
  • Description: Indicates whether opportunity contact roles from external accounts are automatically added to Salesforce (true) or not (false). The default value is false.

When this feature is enabled, users do not see new contact roles as suggestions. The contact roles are added automatically.

Note

enableAddContactRoleWithSuggestion 

  • Type: boolean
  • Required: No
  • Description: Indicates whether opportunity contact roles from external accounts are suggested as new Salesforce opportunity contact roles (true) or not (false). The default value is true.

enableAddContactWithSuggestion 

  • Type: boolean

  • Required: No

  • Description: Indicates whether new contacts from external accounts (such as Microsoft and Google) are suggested as new Salesforce contacts (true) or not (false). The default value is true.

    enableAddContactRoleWithSuggestion must be true to use this setting.

Declarative Metadata Sample Definition 

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

1<?xml version="1.0" encoding="UTF-8"?>
2<AutomatedContactsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<enableAddContactAutomatically>true</enableAddContactAutomatically>
4	<enableAddContactRoleAutomatically>true</enableAddContactRoleAutomatically>
5	<enableAddContactRoleWithSuggestion>true</enableAddContactRoleWithSuggestion>
6	<enableAddContactWithSuggestion>true</enableAddContactWithSuggestion>
7
8</AutomatedContactsSettings>

Example Package Manifest 

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

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