LeadConfigSettings

Represents configuration settings for Leads that control how they are converted and displayed, and what actions are available. This type extends the Metadata metadata type and inherits its fullName field.

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

File Suffix and Directory Location

LeadConfigSettings values are stored in the LeadConfig.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

LeadConfigSettings is available in API versions 47.0 and later.

Fields

Field Name	Field Type	Description
doesEnableLeadConvertDefaultSubjectBlankTaskCreation	boolean	Configures whether tasks without a subject are created during lead conversion. If `true`, tasks are created when the default subject field has no value. If `false`, only tasks with a subject are created.
doesHideOpportunityInConvertLeadWindow	boolean	Hides the opportunity section of the Convert Lead window during the conversion of a lead. Default value is `false`.
doesPreserveLeadStatus	boolean	If your organization uses record types, the lead status changes to the lead status value of the new owner's record type during conversion. Set doesPreserveLeadStatus to `true` to preserve the value of the lead status during conversion. Orgs that use record types can create a lead process that allows different lead status values for different record types. If doesPreserveLeadStatus is `false`, the lead status might change during lead conversion if the new owner's record type has a different default value for lead status. Default value is `true`.
doesSelectNoOpportunityOnConvertLead	boolean	Prevents an opportunity from being created when the lead is converted. Default value is `false`.
doesTrackHistory	boolean	Enables field history tracking for leads. When field history tracking is enabled, users can choose the fields they want to track. Default value is `false`.
enableConversionsOnMobile	boolean	Lets a user convert leads on their mobile devices. The Convert Lead action converts qualified leads to contacts. Default value is `true`.
enableOrgWideMergeAndDelete	boolean	Lets a user merge and delete leads. The user must also have the Public Read/Write/Transfer permission. Default value is `false`.
shouldLeadConvertRequireValidation	boolean	Enforces validation rules when converting leads. Default value is `true`.

Declarative Metadata Sample Definition

The following is an example of the LeadConfigSettings type:

1<?xml version="1.0" encoding="UTF-8"?>
2<LeadConfigSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3
4    <doesEnableLeadConvertDefaultSubjectBlankTaskCreation>true</doesEnableLeadConvertDefaultSubjectBlankTaskCreation>
5    <enableConversionsOnMobile>true</enableConversionsOnMobile>
6    <shouldLeadConvertRequireValidation>true</shouldLeadConvertRequireValidation>
7    <enableOrgWideMergeAndDelete>false</enableOrgWideMergeAndDelete>
8    <doesPreserveLeadStatus>true</doesPreserveLeadStatus>
9    <doesSelectNoOpportunityOnConvertLead>false</doesSelectNoOpportunityOnConvertLead>
10    <doesHideOpportunityInConvertLeadWindow>false</doesHideOpportunityInConvertLeadWindow>
11    <doesTrackHistory>false</doesTrackHistory>
12</LeadConfigSettings>

Example Package Manifest

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

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

Metadata API Developer Guide