PropertyDefinition

The PropertyDefinition object defines the properties on the object type.

Properties

NameData TypeDescription
AttributeMapsAttributeMap[]Reserved for future use.
ClientClientIDSpecifies the account ownership and context of an object.
CorrelationIDxsdIdentifies correlation of objects across several requests.
CreatedDatexsdRead-only date and time of the object's creation.
CustomerKeyxsdUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object in Marketing Cloud.
DataTypexsdThis 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)
DefaultValuexsdThe 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.
DescriptionxsdDescribes and provides information regarding the object.
DisplayOrderxsdSpecifies the position in which the attribute appears on the Subscriber Profile Center page.
IDxsdRead-only identifier for an object. Some objects use the ObjectID property as the Marketing Cloud unique ID.
IsAccountPropertyxsdIndicates whether the property is specific to the account.
IsContextSpecificxsdReserved for future use.
IsCreatablexsdIndicates 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)
IsEditablexsdIndicates if the property can be edited by the end-user in the profile center
IsFilterablexsdIndicates 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.
IsNillablexsdIndicates whether the property can contain a NULL value.
IsPartnerPropertyxsdIndicates if the property is specific to a partner.
IsQueryablexsdIndicates whether the property can be queried.
IsRequiredxsdIndicates 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.
IsRestrictedPicklistxsdIndicates whetherthe property has a restricted list of valid values.
IsRetrievablexsdIndicates if object data can be retrieved.
IsSendTimexsdIndicates whether the property is a send time attribute.
IsUpdatablexsdIndicates whether object can be updated.
IsViewablexsdIndicates whether the property is viewable by the end-user in the profile center.
LabelxsdName or text that is displayed next to the field.
MarkupsAPIProperty[]Deprecated.
MaxLengthxsdMaximum length of the data.
MaxValuexsdIndicates the maximum value that this property can be set to.
MinLengthxsdSpecifies the minimum length of the data.
MinValuexsdSpecifies the minimum value that this property can be set to.
ModifiedDateNullable`1Indicates the last time object information was modified.
NamexsdName of the object or property.
ObjectIDxsdSystem-controlled, read-only text string identifier for object.
ObjectStatexsdReserved for future use.
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyxsdUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerMapxsdDeprecated.
PartnerPropertiesAPIProperty[]A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
PicklistItemsPicklistItem[]Represents a list of the valid values for the property.
PrecisionxsdDefines numeric precision for decimal properties.
PropertyTypePropertyTypeIndicates the Marketing Cloud data type of the property.
ReferencesAPIObject[]Indicates the object types of the referenced objects. Reserved for future use.
RelationshipNamexsdIndicates the name of the relationship. For example, One-to-One or One-to-Many.
ScalexsdIndicates numeric precision for decimal properties.
StatusxsdDefines status of object. Status of an address.
ValueTypeSoapTypeValueType indicates the actual data type of the value that is stored in this property.