---
schema_version: "1"
id: 30bdc836f6273f19b64b217bfd7265584cf48eefde619431c04ff14a8a7d80ac
title: LeadConvertSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_leadconvertsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_leadconvertsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: d716fd60898fb41720b92c91d393415cc39576f40392f12c66712d1e03dea8d2
description: Represents an organization’s custom field mappings for lead conversion. Custom fields can be mapped from Leads to Accounts, Contacts, and Opportunities. Options for creating opportunities during lead conversion can also be specified. This type extends the Metadata metadata type and inherits its fullName field.
---
# LeadConvertSettings

Represents an organization’s custom field mappings for lead conversion. Custom fields can be mapped from Leads to Accounts, Contacts, and Opportunities. Options for creating opportunities during lead conversion can also be specified. 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

LeadConvertSettings components have the suffix LeadConvertSetting and are stored in the LeadConvertSettings folder.

## Version

LeadConvertSettings is available in API versions 39.0 and later.

## Fields

| Field Name | Description |
| --- | --- |
| allowOwnerChange | 
Field Type

boolean

Description

Indicates whether to include the **Record Owner** field in the **Convert Lead** dialog box (true) or not (false).



 |
| objectMapping | 

Field Type

[ObjectMapping\[\]](#ObjectMapping)

Description

A set of custom field mappings between objects. Up to three objectMapping types can be declared—one each for account, contact, and opportunity.



 |
| opportunityCreationOptions | 

Field Type

VisibleOrRequired (enumeration of type string)

Description

This field determines whether the **Opportunity** field is visible or required in the **Convert Lead** dialog box.

Values are:

- VisibleOptional—The **Opportunity** field is included in the dialog box but not required. A new opportunity is created if the user enters an opportunity name. This is the default value.
- VisibleRequired—The **Opportunity** field is included in the dialog box and is required. A new opportunity is created based on the name the user enters.
- NotVisible—The **Opportunity** field is not included in the dialog box. No opportunity is created.





 |

## ObjectMapping

Represents a custom field mapping between two objects.

| Field Name | Description |
| --- | --- |
| inputObject | 
Field Type

string

Description

Required.

The name of the object type containing the source fields for mapping. The value is always Lead.



 |
| mappingFields | 

Field Type

[ObjectMappingField\[\]](#ObjectMappingField)

Description

A set of input and output field names of the custom fields to be mapped.



 |
| outputObject | 

Field Type

string

Description

Required.

The object type receiving data during lead conversion.

- Account
- Contact
- Opportunity





 |

## ObjectMappingField

Represents custom field names to be mapped between objects.

| Field Name | Description |
| --- | --- |
| inputField | 
Field Type

string

Description

Required.

The name of a custom lead field supplying source data during lead conversion.



 |
| outputField | 

Field Type

string

Description

Required.

The name of a custom account, contact, or opportunity field that will receive data from source field named in the accompanying inputField entry.



 |

## Declarative Metadata Sample Definition

The following is an example of the LeadConvertSettings type:

<?xml version="1.0" encoding="UTF-8"?>
<LeadConvertSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <allowOwnerChange\>false</allowOwnerChange\>
    <objectMapping\>
        <inputObject\>Lead</inputObject\>
        <mappingFields\>
            <inputField\>custom\_lead\_field\_1</inputField\>
            <outputField\>custom\_account\_field\_1</outputField\>
        </mappingFields\>
        <mappingFields\>
            <inputField\>custom\_lead\_field\_2</inputField\>
            <outputField\>custom\_account\_field\_2</outputField\>
        </mappingFields\>
        <mappingFields\>
            <inputField\>custom\_lead\_field\_3</inputField\>
            <outputField\>custom\_account\_field\_3</outputField\>
        </mappingFields\>
        <outputObject\>Account</outputObject\>
    </objectMapping\>
    <objectMapping\>
        <inputObject\>Lead</inputObject\>
        <mappingFields\>
            <inputField\>custom\_lead\_field\_4</inputField\>
            <outputField\>custom\_opportunity\_field\_1</outputField\>
        </mappingFields\>
        <outputObject\>Opportunity</outputObject\>
    </objectMapping\>
    <opportunityCreationOptions\>VisibleOptional</opportunityCreationOptions\>
</LeadConvertSettings\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).