LeadConfigSettings

Represents configuration settings for Leads that control how they are converted and displayed, and what actions are available.

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

This type extends Metadata and inherits its fields.

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.

Introduced in API version 47.0.

• Type: boolean
• Required: No
• Description: 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.

• Type: boolean

• Required: No

• Description: Hides the opportunity section of the Convert Lead window during lead conversion.

  Default value is false.

• Type: boolean

• Required: No

• Description: If your org 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.

• Type: boolean

• Required: No

• Description: Prevents an opportunity from being created when the lead is converted.

  Default value is false.

• Type: boolean

• Required: No

• Description: 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.

• Type: boolean

• Required: No

• Description: Lets a user convert leads on their mobile devices. The Convert Lead action converts qualified leads to contacts.

  Default value is true.

• Type: boolean

• Required: No

• Description: Lets a user merge and delete leads. The user must also have the Public Read/Write/Transfer permission.

  Default value is false.

• Type: boolean

• Required: No

• Description: Associates the lead’s emails with the contact that it’s converted to.

  Default value is false.

• Type: boolean

• Required: No

• Description: Enforces validation rules when converting leads.

  Default value is true.

• Type: boolean

• Required: No

• Description: Indicates whether an email notification is sent when the lead owner is updated through Apex in Lightning Experience.

  Default value is false.

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<doesEnableLeadConvertDefaultSubjectBlankTaskCreation>false</doesEnableLeadConvertDefaultSubjectBlankTaskCreation>
4<doesHideOpportunityInConvertLeadWindow>false</doesHideOpportunityInConvertLeadWindow>
5<doesPreserveLeadStatus>true</doesPreserveLeadStatus>
6<doesSelectNoOpportunityOnConvertLead>false</doesSelectNoOpportunityOnConvertLead>
7<doesTrackHistory>false</doesTrackHistory>
8<enableConversionsOnMobile>true</enableConversionsOnMobile>
9<enableOrgWideMergeAndDelete>false</enableOrgWideMergeAndDelete>
10<shouldLeadConvertRequireValidation>true</shouldLeadConvertRequireValidation>
11<shouldSendNotificationEmailWhenLeadOwnerUpdatesViaApexInLEX>false</shouldSendNotificationEmailWhenLeadOwnerUpdatesViaApexInLEX>
12</LeadConfigSettings>

The following is an example package manifest used to deploy or retrieve the LeadConfig 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>61.0</version>
10</Package>