---
schema_version: "1"
id: 97c1ec40351b5b43c0faa9738e6aa98062da907c9b7beb2e26d2d92c95673655
title: PropertyDefinition
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/marketing-cloud/guides/mc-apis/propertydefinition.md
canonical_url: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/propertydefinition.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: ecfb8b5f72b7a2ee303f29b0f5f788e9281bcada3034241272f33315392bd485
products:
  - Marketing Cloud Engagement APIs and Programmatic Languages
  - Marketing Cloud
---
# PropertyDefinition

Defines the properties on the object type.

## 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. This property corresponds to the external key assigned to an object.                                                                                                                                                                                                                                                                |
| `DataType`             | String                                           | This has been deprecated. Please use ValueType. (PropertyDefinition) The data type of the parameter that is passed to the Data Extract. Use this data type 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.                                                                                                                                                                                                                                                                                                             |
| `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 property can be set on a Create call. A value of true indicates it can be created. (PropertyDefinition) Indicates whether object can be created. A value of true indicates it can be created. (ObjectDefinition) Indicates whether the field can be created. A value of true indicates it can be created. (DataExtensionField).                                                         |
| `IsEditable`           | Boolean                                          | Indicates if the property can be edited by the end-user in the profile center.                                                                                                                                                                                                                                                                                                                           |
| `IsFilterable`         | Boolean                                          | Indicates if you can filter on this property. A value of true indicates that the property can be specified 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.                                                                                                                                                                                                                                                                                                                                                      |
| `IsQueryable`          | Boolean                                          | Indicates whether the property can be queried.                                                                                                                                                                                                                                                                                                                                                           |
| `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 can be retrieved.                                                                                                                                                                                                                                                                                                                                                               |
| `IsSendTime`           | Boolean                                          | Indicates whether the property is a send time attribute.                                                                                                                                                                                                                                                                                                                                                 |
| `IsUpdatable`          | Boolean                                          | Indicates whether object can be updated.                                                                                                                                                                                                                                                                                                                                                                 |
| `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                                           | Indicates the maximum value that this property can be set to.                                                                                                                                                                                                                                                                                                                                            |
| `MinLength`            | Int                                              | Specifies the minimum length of the data.                                                                                                                                                                                                                                                                                                                                                                |
| `MinValue`             | String                                           | Specifies the minimum value that this property can be set 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.                                                                                                                                                                                                                                                                                                                                                                                                |
| `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)                  | 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. For example, One-to-One or One-to-Many.                                                                                                                                                                                                                                                                                                                          |
| `Scale`                | Int                                              | Indicates numeric precision for decimal properties.                                                                                                                                                                                                                                                                                                                                                      |
| `Status`               | String                                           | Defines status of object. Status of an address.                                                                                                                                                                                                                                                                                                                                                          |
| `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)
- [Add an Attribute](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/adding_an_attribute_via_the_web_service_api.md "Adding_an_Attribute_Via_the_Web_Service_API")
- [Create a Subscriber Attribute](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/creating_a_subscriber_attribute.md "Creating_a_Subscriber_Attribute")
