Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

CustomField

Represents a custom field on a custom object that stores data unique to your organization. Includes access to the associated CustomField object and related fields in Salesforce Metadata API. Available from API version 28.0 or later.

Supported SOAP Calls

create(), query(), retrieve(), search(), update(), upsert()

Supported REST HTTP Methods

Query, GET, POST, PATCH

Fields

Field Name	Details
DeveloperName	Type string Properties Filter, Group, Sort Description The developer’s internal name for the custom field. For example, the internal name for the custom field CF__c is CF.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
Metadata	Type CustomFieldMetadata Properties Create, Nillable, Update Description CustomFieldMetadata includes these fields. For more information, see CustomField in the Metadata API Developer Guide. `caseSensitive` `complianceGroup` `defaultValue` `deleteConstraint` `deprecated^` `description` `displayFormat` `displayLocationInDecimal` `elementType^` `escapeMarkup` `externalDeveloperName` `externalId` `formula` `formulaTreatBlanksAs` `inlineHelpText` `isAIPredictionField` `isFilteringDisabled` `isNameField` `isSortingDisabled` `label` `length` `maskChar` `maskType` `picklist` `populateExistingRows` `precision` `readOnlyProxy` `referenceTo` `relationshipLabel` `relationshipName` `relationshipOrder` `reparentableMasterDetai` `required` `restrictedAdminField` `scale` `startingNumber` `stripMarkup` `summarizedField` `summaryFilterItems` `summaryForeignKey` `summaryOperation` `trackFeedHistory` `trackHistory` `type` `unique` `visibleLines` `writeRequiresMasterRead` ^* Reserved for future use. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace of the custom field. A custom field can be in an extension namespace different than the object.
creationType	Type DefinitionCreationType (enumeration of type string) Properties Filter, Group, Nillable, Sort Description Describes whether this field was added by the user or as part of a standard taxonomy. Available in API version 67.0 and later: `Ad_Audience_Insights` `Auxiliary` `Clean_Room` `Deletion_Records` `Problem_Records`
TableEnumOrId	Type Restricted picklist Properties Filter, Group, Sort Description The enum (for example, Account) or ID of the object this field is on.

Tooling API

CustomField

Supported SOAP Calls

Supported REST HTTP Methods

Fields