![\"Important\"](\"/docs/resources/img/en-us/264.0?doc_id=images%2Ficon_note_important.png&folder=api_meta\")
Important
\nWhere possible, we changed noninclusive terms to align with our\n company value of Equality. We maintained certain terms to avoid any effect on\n customer implementations.
\nOnly standard fields that you can customize are\n supported, that is, standard fields to which you can add help text or turn on\n history tracking or Chatter feed tracking. Other standard fields aren't\n supported, including system fields (such as CreatedById or\n LastModifiedDate) and auto number fields. Some\n standard picklist fields aren’t supported. See Unsupported Metadata Types. By default, a custom object doesn’t have any\n standard fields that are customizable.
\n\nSpecify the full name whenever you create or update a field. For example, a custom\n field on a custom object:
\n\nMyCustomObject__c.MyCustomField__c\n
An example of a custom field on a standard object:
\n\nAccount.MyAcctCustomField__c
An example of a standard field on a standard object:
\n\nAccount.Phone
An example of a custom field on an external object:
\n\nMyExternalObject__x.MyCustomField__c\n
![\"Note\"](\"/docs/resources/img/en-us/264.0?doc_id=images%2Ficon_note.png&folder=api_meta\")
Note
\nIn Metadata API, external objects are represented by the CustomObject metadata\n type.
These custom field types aren’t available for external objects.
\n- \n
- Auto number (available only with the cross-org adapter for Salesforce\n Connect) \n\n
- Currency (available only with the cross-org adapter for Salesforce\n Connect) \n\n
- Formula \n\n
- Location \n\n
- Master-detail relationship \n\n
- Picklist and multi-select picklist (available only with the cross-org\n adapter for Salesforce Connect) \n\n
- Rollup summary \n\n
- Text (encrypted) \n\n
- Text area (rich) \n\n
Declarative Metadata File Suffix and Directory Location
\n\n \nCustom fields are user-defined fields and are part of the custom object or standard\n object definition. See CustomObject for more information. Standard fields are predefined on\n standard objects.
\n\nNote
\nRetrieving a component of this metadata type in a project makes the component\n appear in any Profile and PermissionSet components that are retrieved in the same\n package.
\nRetrieving Fields on Custom or Standard Objects
\n\n \nWhen you retrieve a custom or standard object, you return everything associated with\n the object, except for standard fields that aren't customizable. You can also\n retrieve only specific fields for an object by explicitly naming the object and\n fields in package.xml. The following definition in\n package.xml creates the files objects/MyCustomObject__c.object and objects/Account.object, each containing the requested field\n definitions.
\n\n<types>\n <members>MyCustomObject__c.MyCustomField__c</members>\n <members>Account.MyCustomAccountField__c</members>\n <members>Account.Phone</members>\n <name>CustomField</name>\n</types>\n
Retrieving or Deploying Fields on Data 360 Objects
\n\n \nWhen you retrieve a Data 360 object, such as a data lake object\n (DLO) or data model object (DMO), not all custom field properties are returned. The\n properties returned depend on the data type of the custom field.
\n\nWhen you deploy a Data 360 object via Metadata API, in API version 60.0 or later,\n the call succeeds only if the properties are supported by the custom field's data\n type. If you include a property that isn't supported by the field's data type, the\n API returns an error.
\n\nData 360 objects support these data types.
\n\n- \n
- Boolean/Checkbox \n\n
- Date \n\n
- DateTime \n\n
- Lookup (DMOs only) \n\n
- Number \n\n
- Percent \n\n
- Phone \n\n
- Text \n\n
- Url \n\n
Version
\n\n \nCustom and standard fields are available in API version 10.0 and later.
\n\nFields
\n\n \nUnless otherwise noted, all fields are creatable,\n filterable, and nillable.
\n\n \n \n| Field Name | \n\nField Type | \n\nDescription | \n\n
|---|---|---|
| businessOwnerGroup | \n\nreference | \n\nGroup associated with this field. The business owner group\n understands the importance of the field’s data to your company, and\n can be responsible for determining the minimum security\n classification. This field is available in API version 45.0 and\n later. | \n\n
| businessOwnerUser | \n\nreference | \n\nPerson associated with this field. The business owner understands\n the importance of the field’s data to your company, and can be\n responsible for determining the minimum security classification.\n This field is available in API version 45.0 and later. | \n\n
| businessStatus | \n\npicklist | \n\nIndicates if the field is in use. Valid values are:
| \n\n
| caseSensitive | \n\nboolean | \n\nIndicates whether the field is case-sensitive (true) or not (false). For indirect lookup\n relationship fields on external objects, this attribute affects\n how this custom field’s values are matched against the values of\n the referenceTargetField. \n | \n\n
| complianceGroup | \n\nmultipicklist | \n\nCompliance acts, definitions, or regulations related to the\n field’s data. Valid values are:
| \n\n
| customDataType | \n\nstring | \n\nDeprecated in the Spring ‘19 (API version 45.0) release. | \n\n
| defaultValue | \n\nstring | \n\nIf specified, represents the\n default value of the field. | \n\n
| deleteConstraint | \n\nDeleteConstraint (enumeration of type string) | \n\n\nDeletion options for lookup\n relationships. Valid values are:
For more information on\n lookup relationships, see Object\n Relationships Overview. \n | \n\n
| deprecated | \n\nboolean | \n\nReserved for future use. | \n\n
| description | \n\nstring | \n\nDescription of the field. | \n\n
| displayFormat | \n\nstring | \n\nDisplay format of the field. | \n\n
| displayLocationInDecimal | \n\nboolean | \n\nIndicates how the geolocation\n values of a custom location field appear in the user interface.\n If true, the\n geolocation values appear in decimal notation. If false, the geolocation\n values appear as degrees, minutes, and seconds. | \n\n
| elementType | \n\nElementType (enumeration of type string) | \n\nReserved for future use. | \n\n
| encryptionScheme | \n\nEncryptionScheme (enumeration of type string) | \n\nFor encrypted fields, determines which encryption scheme a field\n takes. Valid values are:
| \n\n
| externalDeveloperName | \n\nstring | \n\nAvailable only for external objects. Name of the table column on\n the external data source that maps to this custom field in\n Salesforce. Corresponds to the External Column\n Name in the user interface. This field is available\n in API version 32.0 and later. | \n\n
| externalId | \n\nboolean | \n\nIndicates whether the field is an\n external ID field (true) or\n not (false). This property is\n returned only if the custom field data type is auto number,\n email, number, or text. | \n\n
| fieldManageability | \n\nFieldManageability (enumeration of type string) | \n\nDetermines who can update the field after it’s released in a\n managed package. Valid values are:
| \n\n
| formula | \n\nstring | \n\nIf specified, represents a formula on\n the field. | \n\n
| formulaTreatBlanksAs | \n\nTreatBlanksAs (enumeration of type string) | \n\nIndicates how to treat\n blanks in a formula. Valid values are BlankAsBlank and BlankAsZero. | \n\n
| fullName | \n\nstring | \n\nFull name of the object. It must be specified when creating,\n updating, or deleting the object. See createMetadata() to see an\n example of this field specified for a call.\n | \n\n
| globalPicklist | \n\nstring. | \n\nIf this custom field is a picklist that’s based on a global\n picklist, globalPicklist is the name of the\n global picklist whose value set this picklist inherits. A custom\n picklist that’s based on a global picklist is restricted. You can\n only add or remove values by editing the global picklist. This field\n is available only in API version 37.0. | \n\n
| indexed | \n\nboolean | \n\nIndicates whether the field is indexed (true) or not (false). If this field is unique or the\n externalId is set true, the isIndexed value is set\n to true. This field is available only in API version 14.0 and\n earlier. | \n\n
| inlineHelpText | \n\nstring | \n\nContent of field-level help. For\n more information, see Define Field-Level Help. | \n\n
| \nisAIPredictionField\n | \n\nboolean | \n\n\nAvailable for number\n type custom fields when you use Einstein Prediction Builder.\n Indicates whether the field can store and display Einstein\n prediction data on an object (true) or not (false). Use Einstein Prediction Builder to\n determine the data for the target field. This field is\n available in API version 43.0 and later. | \n\n
| isFilteringDisabled | \n\nboolean | \n\n\nAvailable only for\n external objects. Indicates whether the custom field is\n available in filters (true)\n or not (false). This\n field is available in API version 32.0 and later. | \n\n
| isNameField | \n\nboolean | \n\n\nAvailable only for external\n object fields of type text. Indicates whether the custom field\n is the name field (true) or\n not (false). For each\n external object, you can specify one field as the name\n field. If you set this value to true, ensure the external table column identified by\n the externalDeveloperName attribute contains\n name values. This field is available in API version 32.0 and\n later. | \n\n
| isSortingDisabled | \n\nboolean | \n\n\nAvailable only for external\n objects. Indicates whether the custom field is sortable (true) or not (false). This field is\n available in API version 32.0 and later. | \n\n
| label | \n\nstring | \n\n\nLabel for the field. You can't\n update the label for standard picklist fields, such as the\n Industry field for accounts. | \n\n
| length | \n\nint | \n\nLength of the field. | \n\n
| lookupFilter | \n\nLookupFilter | \n\nMetadata associated with a lookup\n filter definition. This field is only available in API version 30.0\n and earlier. The metadata\n associated with a lookup filter is now represented by the\n lookupFilter field in the CustomField\n component. LookupFilter isn't supported on the article\n type object. \n | \n\n
| maskChar | \n\nEncryptedFieldMaskChar (enumeration of type string) | \n\n\n For encrypted fields, specifies the character to be used as a\n mask. Valid values are: \n\n
This value pertains to Classic Encryption, not Shield Platform\n Encryption. For more information on encrypted fields, see Classic\n Encryption for Custom Fields in Salesforce Help. \n\n | \n\n
| maskType | \n\nEncryptedFieldMaskType (enumeration of type string) | \n\n\n For encrypted text fields, specifies the format of the masked\n and unmasked characters in the field. Valid values are: \n
| \n\n
| metadataRelationshipControllingField | \n\nstring | \n\n\nIn\n custom metadata relationships, represents the controlling field\n that specifies the standard or custom object in an entity\n definition metadata relationship. Required when creating a field\n definition or entity particle metadata relationship on a custom\n metadata type. The object specified in the controlling field\n determines the values available in its dependent field\n definition or entity particle. For example, specifying the\n Account object filters the available fields in the field\n definition to Account fields only. This field is available\n in API version 39.0 and later. | \n\n
| picklist | \n\nPicklist | \n\nIf specified, the field is a\n picklist, and this field counts the picklist values and labels.\n This field is available only in API version 37.0 and earlier. In\n later versions, use valueSet\n instead. | \n\n
| populateExistingRows | \n\nboolean | \n\nIndicates whether existing rows are going to be populated\n (true) or not (false). | \n\n
| precision | \n\nint | \n\nPrecision, or number of digits in a\n number value. For example, the number 256.99 has a precision\n value of 5. | \n\n
| referenceTargetField | \n\nstring | \n\nSpecifies the custom field on the parent object to match against\n this indirect lookup relationship field, whose values come from an\n external data source. The specified custom field on the parent\n object must have both externalId and\n unique set to true. Available only for indirect lookup relationship\n fields on external objects. This field is available in API version\n 32.0 and later. | \n\n
| referenceTo | \n\nstring | \n\nReference this field has to\n another object. | \n\n
| relationshipLabel | \n\nstring | \n\nLabel for the\n relationship. | \n\n
| relationshipName | \n\nstring | \n\nValue for one-to-many\n relationships. For example, if MyObject has a relationship to\n YourObject, the relationship name can be\n YourObjects. | \n\n
| relationshipOrder | \n\nint | \n\n\nThis field is valid for all\n master-detail relationships, but the value is only non-zero for\n junction objects. A junction object has two master-detail\n relationships, and is analogous to an association table in a\n many-to-many relationship. Junction objects must define one\n parent object as primary (0), the other as secondary (1). The\n definition of primary or secondary affects delete behavior and\n inheritance of look and feel, and record ownership for junction\n objects. 0 or 1 are the only\n valid values, and 0 is always the value for objects that aren't\n junction objects. \n | \n\n
| reparentableMasterDetail | \n\nboolean | \n\n\nIndicates whether the\n child records in a master-detail relationship on a custom object\n can be reparented to different parent records (true) or not (false). The default value is\n false. This field\n is available in API version 25.0 and later. \n | \n\n
| required | \n\nboolean | \n\nIndicates whether the field requires\n a value on creation (true) or\n not (false). | \n\n
| scale | \n\nint | \n\nScale, or the number of digits to the\n right of the decimal point in a number. For example, the number\n 256.99 has a scale of 2. | \n\n
| securityClassification | \n\npicklist | \n\nSensitivity of the data contained in the field. Valid values are:
| \n\n
| startingNumber | \n\nint | \n\nStarting number for the field. When you create records, the\n Starting Number value increments to store\n the number that will be assigned to the next auto number field\n created.
| \n\n
| stripMarkup | \n\nboolean | \n\nIndicates whether to remove markup (true) or preserve it (false). Used when converting a rich text area to a\n long text area. | \n\n
| summarizedField | \n\nstring | \n\nField on the detail row that’s being summarized. This field can't\n be null unless the summaryOperation value is\n count. | \n\n
| summaryFilterItems | \n\nFilterItem[] | \n\nSet of filter conditions for this field if it's a summary field.\n This field is summed in the child if the filter conditions are\n met. | \n\n
| summaryForeignKey | \n\nstring | \n\nMaster-detail field on the child that defines the relationship\n between the parent and the child. | \n\n
| summaryOperation | \n\nSummaryOperations (enumeration of type string) | \n\nRepresents the type of sum operation to be performed. Valid\n values are: \n
| \n\n
| trackFeedHistory | \n\nboolean | \n\n\nIndicates whether the field is\n enabled for feed tracking (true) or not (false). To set this field to true, the\n enableFeeds field on the associated CustomObject\n must also be true. For more\n information, see Customize\n Chatter Feed Tracking. This field is available in API\n version 18.0 and later. \n | \n\n
| trackHistory | \n\nboolean | \n\n\nIndicates whether history tracking\n is enabled for the field (true) or not (false). Also available for standard object\n fields (picklist and lookup fields only) in API version 30.0 and\n later. To set trackHistory to\n true, the\n enableHistory field on the associated\n standard or custom object must also be\n true. \nField history tracking isn’t\n available for external objects. \n | \n\n
| trackTrending | \n\nboolean | \n\n\nIndicates whether historical\n trending data is captured for the field (true) or not (false).\n An object is enabled for\n historical trending if this attribute is true for at least one field.\n This field is available in API version 29.0 and later. For more\n information, see Report on\n Historical Changes. \n | \n\n
| trueValueIndexed | \n\nboolean | \n\nRelevant only for a checkbox field. If set, true values are built into the\n index. This field is available only in API version 14.0 and\n earlier. | \n\n
| type | \n\nFieldType (enumeration of type string) | \n\nType of field. Optional for standard fields on standard objects.\n This field is included for some standard field types, such as\n picklist or lookup, but not for others. The\n type field is included for custom\n fields. | \n\n
| unique | \n\nboolean | \n\nIndicates whether the field is unique (true) or not (false). | \n\n
| valueSet | \n\nValueSet | \n\nSet of values that make up a picklist on a custom field. Each\n value is defined as a CustomValue. If this custom field is a picklist that\n uses a global value set, valueSet is the name\n of the global value set whose values this picklist inherits. A\n custom picklist that uses a global value set is restricted. You can\n only add or remove values by editing the global value set. A\n ValueSet component has either a\n valueSetDefinition or a\n valueName specified, but never\n both. \nThis field is available in API version 38.0 and\n later. \n | \n\n
| visibleLines | \n\nint | \n\nNumber of lines shown for the\n field. | \n\n
| writeRequiresMasterRead | \n\nboolean | \n\n\nMinimum sharing access level\n required on the primary record to create, edit, or delete child\n records. This field applies only to master-detail or junction\n object custom field types.
For junction objects, the\n most restrictive access from the two parents is enforced. For\n example, if you set to true\n on both master-detail fields, but users have Read access to one\n primary record and Read/Write access to the other primary\n record, users aren't able to create, edit, or delete child\n records. \n | \n\n
Fields use additional data types. For more information, see Metadata Field Types.
\n\nMktDataModelFieldAttributes
\n\n \n \n \nRepresents the Data 360 data model field attributes for a custom field. This type is\n a subtype of CustomField.
\n\n \n| Field Name | \n\nField Type | \n\nDescription | \n\n
|---|---|---|
| definitionCreationType | \n\nDefinitionCreationType enumeration\n | \n\nHow the object was added. Valid values are:
In API version 62.0 and later, additional valid values are:\n \n
In API version 67.0 and later, additional valid values are:\n \n
| \n\n
| invalidMergeActionType | \n\nInvalidMergeActionType (enumeration of type string) | \n\nAction to take when an invalid merge occurs for a field used to\n merge data. Valid values are:
| \n\n
| isDynamicLookup | \n\nboolean | \n\nIndicates whether existing data is queried for the field’s unique\n values (true) or not (false). | \n\n
| labelOverride | \n\nstring | \n\nCustom label that overrides the field’s default display label in\n the data model. If unspecified, the default label is used. Maximum\n length is 255 characters. This field is available in API version\n 65.0 and later. | \n\n
| mappingAlertType | \n\nMappingAlertType (enumeration of type string) | \n\n\n Type of alert shown when this field isn't mapped in the\n data model. This field is available in API version 65.0 and\n later. Valid values are: \n\n
| \n\n
| masterLabel | \n\nstring | \n\nMaster label for the field. Maximum length is 40 characters. This\n field is available in API version 65.0 and later. | \n\n
| primaryIndexOrder | \n\nint | \n\nPosition of the field in the primary key, starting at\n 1. If specified, the field is part of the\n primary key. For a compound primary key, the value specifies the\n field’s position in the key. | \n\n
| refAttrDeveloperName | \n\nstring | \n\n \nDeveloper name of the field in the reference model. Applies only\n to standard fields. | \n\n
| mktDatalakeSrcKeyQualifier | \n\nstring | \n\nDeveloper name of the MktDataLakeSrcKeyQualifier configured in\n the field. | \n\n
MktDataLakeFieldAttributes
\n\n \nRepresents the Data 360 data lake field attributes for a custom field. This type is a\n subtype of CustomField. Available in API version 50.0 or later.
\n\n \n| Field Name | \n\nField Type | \n\nDescription | \n\n
|---|---|---|
| definitionCreationType | \n\nDefinitionCreationType (enumeration of type string) | \n\nHow the object was added. Valid values are:
In API version 62.0 and later, additional valid values are:\n \n
| \n\n
| dateFormat | \n\nstring | \n\nOptional date format of date and time fields. This field is\n available only in API version 55.0 and earlier. | \n\n
| externalName | \n\nstring | \n\nExternal name of this field. | \n\n
| isEventDate | \n\nboolean | \n\nIndicates whether this field contains the event date for\n behavioral model area objects that are used to partition data\n (true) or not (false). | \n\n
| primaryIndexOrder | \n\nint | \n\nPosition of the field in the primary key, starting at\n 1. If specified, the field is part of the\n primary key. For a compound primary key, the value specifies the\n field’s position in the key. | \n\n
| isInternalOrganization | \n\nboolean | \n\nIndicates whether this field contains the value for internal\n organization (true) or not\n (false). The value of the\n field is the name of the internal organization. Landing objects\n don't have access to the Salesforce ID and use the developer name\n instead. | \n\n
| isRecordModified | \n\nboolean | \n\nIndicates whether the field is the record modified field used to\n calibrate latest record version (true) or not (false). | \n\n
| mktDatalakeSrcKeyQualifier | \n\nstring | \n\nDeveloper name of the MktDataLakeSrcKeyQualifier configured in\n the field. This field is available in API version 55.0 and\n later. | \n\n
| keyQualifierName | \n\nstring | \n\nDeveloper name of key qualifier field. This field is available in\n API version 55.0 and later. | \n\n
LookupFilter
\n\n \nRepresents the metadata associated with a lookup filter.\n Replaces the NamedFilter component, which was removed as of API version\n 30.0. LookupFilter is available in API version 30.0 and later.
\n\n \n| Field | \n\nField Type | \n\nDescription | \n\n
|---|---|---|
| active | \n\nboolean | \n\nRequired. Indicates whether the lookup filter is active (true) or not (false). | \n\n
| booleanFilter | \n\nstring | \n\nAdvanced filter conditions. | \n\n
| description | \n\nstring | \n\nDescription of what this filter does. | \n\n
| errorMessage | \n\nstring | \n\nError message that appears if the lookup filter fails. | \n\n
| filterItems | \n\nFilterItem[] | \n\nRequired. Set of filter conditions. You can have up to 10 FilterItems per lookup\n filter.\n | \n\n
| infoMessage | \n\nstring | \n\nInformation message displayed on the page. Use this field\n describe things the user possibly doesn't understand, such as why\n certain items are excluded in the lookup filter. | \n\n
| isOptional | \n\nboolean | \n\nRequired. Indicates whether the lookup filter is optional\n (true) or not (false). | \n\n
Lookup filters use additional data types. For more information, see Metadata Field Types.
\n\nFilterItem
\n\n \nRepresents one entry in a set of filter criteria.
\n\n \n| Field | \n\nField Type | \n\nDescription | \n\n
|---|---|---|
| field | \n\nstring | \n\nName of the field specified in the filter. | \n\n
| operation | \n\nFilterOperation (enumeration of type string) | \n\n\nFilter operation for this filter\n item. Valid values are:
| \n\n
| value | \n\nstring | \n\nValue of the filter item being operated on, for example, if the\n filter is my_number_field__c >\n 1, the value of value is 1. | \n\n
| valueField | \n\nstring | \n\nFinal column in the filter contains a field or a field value.\n Approval processes don’t support valueField\n entries in filter criteria. | \n\n
Declarative Metadata Sample Definition
\n\n \nThe following example shows a field definition for a custom field that’s named\n Comments__c.
\n\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n....\n<fields>\n <fullName>Comments__c</fullName>\n <description>Add your comments about this object here</description>\n <inlineHelpText>This field contains help text for this object</inlineHelpText>\n <label>Comments</label>\n <length>32000</length>\n <type>LongTextArea</type>\n <visibleLines>30</visibleLines>\n</fields>\n....\n</CustomObject>
This XML is the definition for two fields on the Account standard object—a\n custom field (MyCustomAccountField__c), and a standard field\n (Phone) that has history tracking enabled.
\n\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CustomObject xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <fields>\n <fullName>MyCustomAccountField__c</fullName>\n <description>A custom field on the Account standard object.</description>\n <externalId>false</externalId>\n <inlineHelpText>Some help text.</inlineHelpText>\n <label>MyCustomAccountField</label>\n <length>100</length>\n <required>false</required>\n <trackFeedHistory>false</trackFeedHistory>\n <trackHistory>false</trackHistory>\n <type>Text</type>\n <unique>false</unique>\n </fields>\n <fields>\n <fullName>Phone</fullName>\n <trackFeedHistory>false</trackFeedHistory>\n <trackHistory>true</trackHistory>\n </fields>\n</CustomObject>
Wildcard Support in the Manifest File
\n\n \nThis metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file.\n For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip\n File.
\n\n