SendDefinition

The SendDefinition object is the base class representing the settings for a send.

NameData TypeDescription
CategoryIDIntSpecifies the identifier of the folder.
ClientClientIDSpecifies 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.
DeliveryProfileDeliveryProfileIdentifies the delivery profile included in a send classification.
DescriptionStringDescribes and provides information regarding the object.
DomainTypeDeliveryProfileDomainTypeEnumDefines the type of domain associated with a delivery profile or send definition. Valid values include DefaultDomain or CustomDomain.
FooterContentAreaContentAreaDefines footer content area to use as part of a delivery profile or send definition.
FooterSalutationSourceSalutationSourceEnumDefines source of a footer salutation to use as part of a delivery profile or send definition. Valid values include:
  • Default
  • Content Library
  • None
FromAddressStringIndicates From address associated with a object. Deprecated for email send definitions and triggered send definitions.
FromNameStringSpecifies the default email message From Name. Deprecated for email send definitions and triggered send definitions.
HeaderContentAreaContentAreaDefines content area to be used in the header of a delivery profile or a send definition.
HeaderSalutationSourceSalutationSourceEnumDefines source of header salutation for a delivery profile or send definition. Valid values include:
  • Default
  • Content Library
  • None
IDIntRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
InteractionObjectIDStringReturns associated ID for activities within the asynchronous process of the overall conversation or program.
IsSendLoggingBooleanIndicates whether send logging is enabled for the specified send definition.
KeywordStringNot used.
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.
OwnerOwnerDescribes 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.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
PrivateDomainPrivateDomainDefines private domain to use as part of a delivery profile or send definition.
PrivateIPPrivateIPContains information about the private IP address associated with a delivery profile.
SendClassificationSendClassificationIndicates the send classification to use as part of a send definition.
SenderProfileSenderProfileIdentifies the sender profile included in the send classification.
SourceAddressTypeDeliveryProfileSourceAddressTypeEnumIndicates the source IP address type used with the delivery profile. Valid values include DefaultPrivateIPAddress and CustomPrivateIPAddress.
SuppressTrackingBooleanIndicates whether the send definition suppresses tracking results for associated sends.

Valid values for the HeaderSalutationSource and FooterSalutationSource properties includes the following: