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.

CustomFieldMember

Represents the working copy of a field for editing or saving in a MetadataContainer. This object is available in API version 33.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API HTTP Methods

Query, GET, POST, PATCH, DELETE

Special Access Rules

To access CustomFieldMember, you must have both the View All Data and Customize Application user permissions.

Fields

Field Name	Details
Content	Type string Properties None Description A string representation of CustomField that contains the field’s metadata.
ContentEntityId	Type ID Properties Create, Filter, Group, Sort Description A reference to a custom field. There can be only one ContentEntityId per CustomField, otherwise, an error is reported.
FullName	Type string Properties Group, Nillable Description The full name of the associated object in the Metadata API. Use to avoid race conditions on create, before you have IDs. 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.
IsDeleted	Type boolean Properties Group, Nillable Description Indicates whether the object is marked as deleted (`true`) or not (`false`).
LastSyncDate	Type dateTime Properties Filter, Sort Description The date that this CustomField was replicated from the underlying entity.
Metadata	Type CustomField Properties None Description An object that describes the version, status, and packaged versions of the corresponding CustomField. 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.

Tooling API

CustomFieldMember

Supported SOAP API Calls

Supported REST API HTTP Methods

Special Access Rules

Fields