PropertyDefinition

Defines the properties on the object type.

NameData TypeDescription
AttributeMapsArray of AttributeMap objectsNot used.
ClientClientID objectSpecifies the account ownership and context of an object.
CorrelationIDStringIdentifies correlation of objects across several requests.
CreatedDateDateTimeThe date and time when the object was created.
CustomerKeyStringUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
DataTypeStringThis 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).
DefaultValueStringThe 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.
DescriptionStringDescribes and provides information regarding the object.
DisplayOrderIntSpecifies the position in which the attribute appears on the Subscriber Profile Center page.
IDIntRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
IsAccountPropertyBooleanIndicates whether the property is specific to the account.
IsContextSpecificBooleanNot used.
IsCreatableBooleanIndicates 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).
IsEditableBooleanIndicates if the property can be edited by the end-user in the profile center.
IsFilterableBooleanIndicates 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.
IsNillableBooleanIndicates whether the property can contain a NULL value.
IsPartnerPropertyBooleanIndicates if the property is specific to a partner.
IsQueryableBooleanIndicates whether the property can be queried.
IsRequiredBooleanIndicates 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.
IsRestrictedPicklistBooleanIndicates whetherthe property has a restricted list of valid values.
IsRetrievableBooleanIndicates if object data can be retrieved.
IsSendTimeBooleanIndicates whether the property is a send time attribute.
IsUpdatableBooleanIndicates whether object can be updated.
IsViewableBooleanIndicates whether the property is viewable by the end-user in the profile center.
LabelStringName or text that is displayed next to the field.
MarkupsArray of APIProperty objectsDeprecated.
MaxLengthIntMaximum length of the data.
MaxValueStringIndicates the maximum value that this property can be set to.
MinLengthIntSpecifies the minimum length of the data.
MinValueStringSpecifies the minimum value that this property can be set to.
ModifiedDateDateTimeThe date and time when the object was last modified.
NameStringName of the object or property.
ObjectIDStringSystem-controlled, read-only text string identifier for object.
ObjectStateStringNot used.
OwnerOwner objectDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyStringUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerMapStringDeprecated.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
PicklistItemsArray of PicklistItem objectsRepresents a list of the valid values for the property.
PrecisionIntDefines numeric precision for decimal properties.
PropertyTypePropertyTypeIndicates the data type of the property.
ReferencesArray of APIObject objectsIndicates the object types of the referenced objects. Not used.
RelationshipNameStringIndicates the name of the relationship. For example, One-to-One or One-to-Many.
ScaleIntIndicates numeric precision for decimal properties.
StatusStringDefines status of object. Status of an address.
ValueTypeSoapType objectValueType indicates the actual data type of the value that is stored in this property.