--- schema_version: "1" id: be3d9349e64ed32a2209bfa20e27338d69cf26c9b47c81ea99196fbafe19d748 title: DataExtensionField collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/marketing-cloud/guides/mc-apis/dataextensionfield.md canonical_url: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/dataextensionfield.html source_site: developer.salesforce.com content_type: documentation content_hash: 567b554c9834f3591dc150b5200436026682d02ef921ed6cad6124a7aac91cfb products: - Marketing Cloud Engagement APIs and Programmatic Languages - Marketing Cloud --- # DataExtensionField An object that represents a field in a data extension. ## Properties | Name | Data Type | Description | | ---------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AttributeMaps` | Array of [AttributeMap](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/attributemap.md) objects | Not used. | | `Client` | [ClientID](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/clientid.md) object | Specifies the account ownership and context of an object. | | `CorrelationID` | String | Identifies correlation of objects across several requests. | | `CreatedDate` | DateTime | The date and time when the object was created. | | `CustomerKey` | String | User-supplied unique identifier for an object within an object type, which corresponds to the external key assigned to an object. | | `DataExtension` | [DataExtension](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/dataextension.md) object | Specifies the data extension. | | `DataType` | String | This has been deprecated. Use ValueType. (PropertyDefinition) The data type of the parameter that is passed to the Data Extract, which can be used to dynamically build a user interface with some basic data validation. (ExtractParameterDescription). | | `DefaultValue` | String | The default value for a data extension field if no value is supplied (Include Now() as the default value if you wish to have a field default to today's date). Used by ExtractParameterDescription as the default value for the parameter if not suppliedwhen a data extract is executed. Used by PropertyDefinition if the default value for the attribute if not suppliedfor a data profile attribute. | | `Description` | String | Describes and provides information regarding the object. | | `DisplayOrder` | Int | Specifies the position in which the attribute appears on the Subscriber Profile Center page. | | `FieldType` | [DataExtensionFieldType](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/dataextensionfieldtype.md) object | Designates data type for a data extension field. | | `ID` | Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. | | `IsAccountProperty` | Boolean | Indicates whether the property is specific to the account. | | `IsContextSpecific` | Boolean | Not used. | | `IsCreatable` | Boolean | Indicates if the PropertyDefinition, ObjectDefinition, or DataExtensionField can be set on a Create call. A value of true indicates it is creatable. | | `IsEditable` | Boolean | Indicates if the property is editable by the end-user in the profile center. | | `IsFilterable` | Boolean | Indicates if you can filter on this property. Set to true to specify the property in a SimpleFilterPart in a Retrieve call. | | `IsNillable` | Boolean | Indicates whether the property can contain a NULL value. | | `IsPartnerProperty` | Boolean | Indicates if the property is specific to a partner. | | `IsPrimaryKey` | Boolean | Designates whether a data extension field is used as a primary key for that data extension. | | `IsQueryable` | Boolean | Indicates whether the property is queryable. | | `IsRequired` | Boolean | Indicates whether the property must have a value specified. Create calls must include a supplied value, while Update and Delete calls don't require a value. | | `IsRestrictedPicklist` | Boolean | Indicates whetherthe property has a restricted list of valid values. | | `IsRetrievable` | Boolean | Indicates if object data is retrievable. | | `IsSendTime` | Boolean | Indicates whether the property is a send time attribute. | | `IsUpdatable` | Boolean | Indicates whether object is updatable. | | `IsViewable` | Boolean | Indicates whether the property is viewable by the end-user in the profile center. | | `Label` | String | Name or text that is displayed next to the field. | | `Markups` | Array of [APIProperty](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/apiproperty.md) objects | Deprecated. | | `MaxLength` | Int | Maximum length of the data. | | `MaxValue` | String | Specifies the maximum value to set this property to. | | `MinLength` | Int | Specifies the minimum length of the data. | | `MinValue` | String | Specifies the minimum value to set this property to. | | `ModifiedDate` | DateTime | The date and time when the object was last modified. | | `Name` | String | Name of the object or property. | | `ObjectID` | String | System-controlled, read-only text string identifier for object. | | `ObjectState` | String | Not used. | | `Ordinal` | Int | Indicates position of object within an array. | | `Owner` | [Owner](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/owner.md) object | Describes account ownership of subscriber in an on-your-behalf account. | | `PartnerKey` | String | Unique identifier provided by partner for an object. This property is accessible only via API. | | `PartnerMap` | String | Deprecated. | | `PartnerProperties` | Array of [APIProperty](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/apiproperty.md) objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. | | `PicklistItems` | Array of [PicklistItem](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/picklistitem.md) objects | Represents a list of the valid values for the property. | | `Precision` | Int | Defines numeric precision for decimal properties. | | `PropertyType` | [PropertyType](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/propertytype.md) object | Indicates the data type of the property. | | `References` | Array of [APIObject](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/apiobject.md) objects | Indicates the object types of the referenced objects. Not used. | | `RelationshipName` | String | Indicates the name of the relationship, such as One-to-One, One-to-Many. | | `Scale` | Int | Indicates numeric precision for decimal properties. | | `Status` | String | Defines status of object. Status of an address. | | `StorageType` | DataExtensionFieldStorageType | Indicates special storage properties for the field. Valid values are: Unspecified, Plain, Encrypted, or Obfuscated. | | `ValueType` | [SoapType](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/soaptype.md) object | ValueType indicates the actual data type of the value that is stored in this property. | ## Related Items - [Supported Operations for Objects and Methods](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/supported_operations_for_objects_and_methods.md)