EmailSendDefinition

The EmailSendDefinition object contains the message information, sender profile, delivery profile, and audience information.

  • To create an EmailSendDefinition with a SendDefinitionList where the DataSourceTypeID=List and SendDefinitionListType=SourceList, you need the Email | Subscribers | List | SendEmailToList permission.
  • To create or update an EmailSendDefinition with a SendDefinitionList where the ID is the All Subs List, you need the Email | Subscribers | All Subscribers | SendEmailToList and View permissions.
  • To start or test an EmailSendDefinition using the perform method, you need the Email | Content | Email | Send or Test Send permissions.

Properties

NameData TypeDescription
AdditionalxsdThe ID for a send that customers use as a campaign ID. This property contains external campaign ID information or more metadata that appears in the tracking extract, and there is a personalization string for it. You can set this information at the time of the send or within an email send definition.
AutoBccEmailxsdDefines blind carbon copy email address to which to send a message as part of an email send definition.
BccEmailxsdIndicates email addresses to receive blind carbon copy of a message. The BccEmail property allows access to the BCC feature if enabled on the account. It does not error out if feature is not enabled. The API returns no tracking information for BCC emails. You must specify this property in an email send definition, as you cannot specify this property at send time. You can create a profile attribute for this property and pass in a value at send time, however.

CategoryIDxsdSpecifies the identifier of the folder.
CCEmailxsdCarbon copy email address. You must specify the CCEmail property in an email send definition, as you cannot specify this property at send time. You can create a profile attribute for this property and pass in a value at send time, however.
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.
DeduplicateByEmailxsdIndicates whether a send definition de-duplicates multiple emails sent to the same email address. Set to true to ensure that only one message is sent to a single email address, if that email appears on several different lists or data extensions in a send definition.
DeliveryProfileDeliveryProfileIdentifies the delivery profile included in a send classification.
DeliveryScheduledTimexsdDefines scheduled data and time for a send related to an email send definition.
DescriptionxsdDescribes 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.
DynamicEmailSubjectxsdContains content to be used in a dynamic subject line.
EmailEmailDefault email address for object. Indicates if subscriber information can be used for email sends.
EmailSubjectxsdSubject for an email send. This property is required when updating a user-initiated send definition. If you don't pass the new subject to the email send definition, it retains the old subject for that definition. You must also specify the send classification to use as part of the send.
ExclusionFilterxsdContains a string of AMPscript that can evaluate to true or false, used to exclude email addresses from a send definition. If you include an ExclusionFilter in a create call, you must also include the SendDefinitionList property. The ExclusionFilter property can cause performance issues with send time for large amounts of email addresses. Use the data filter function if you experience performance problems.
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
FromAddressxsdIndicates From address associated with a object. Deprecated for email send definitions and triggered send definitions.
FromNamexsdSpecifies 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
IDxsdRead-only identifier for an object. Some objects use the ObjectID property as the Marketing Cloud unique ID.
InteractionObjectIDxsdReturns associated ID for activities within the asynchronous process of the overall conversation or program.
IsMultipartxsdIndicates whether the email is sent with Multipart/MIME enabled.
IsSeedListSendxsdIndicates whether a email send includes the use of a seed list.
IsSendLoggingxsdIndicates whether send logging is enabled for the specified send definition
IsWrappedxsdIndicates whether an email send contains the links necessary to process tracking information for clicks.
KeywordxsdReserved for future use.
MessageDeliveryTypeMessageDeliveryTypeEnumEnumerates the types of message delivery options available for email send definitions. Valid values include:
  • Standard - use as default unless your account is configured to handle burst sending
  • DelayedDeliveryByMTAQueue
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.
PartnerPropertiesAPIProperty[]A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
PreHeaderxsdContains text used in preheader of email message on mobile devices.
PrivateDomainPrivateDomainDefines private domain to use as part of a delivery profile or send definition.
PrivateIPPrivateIPContains information on the private IP address associated with a delivery profile.
ReplyToAddressxsdSpecifies the reply address used for any messages sent using this send definition.
ReplyToDisplayNamexsdOptional value that specifies the display name for the email address contained in the ReplyToAddress property.
SeedListOccurancexsdProperty definition.
SendClassificationSendClassificationIndicates the send classification to use as part of a send definition. This field is required when updating a user-initiated send definition.
SendDefinitionListSendDefinitionList[]Indicates the subscriber list to use as part of an email send definition.
SenderProfileSenderProfileIdentifies the sender profile included in the send classification.
SendLimitxsdIndicates limit of messages to send as part of a send definition within a predefined send window.
SendWindowClosexsdDefines the end of a send window for a send definition.
SendWindowDeletexsdIndicates whether an existing send window for a send definition is deleted.
SendWindowOpenxsdDefines the beginning of a send window for a send definition.
SourceAddressTypeDeliveryProfileSourceAddressTypeEnumIndicates the source IP address type used with the delivery profile. Valid values include DefaultPrivateIPAddress and CustomPrivateIPAddress.
SuppressTrackingxsdIndicates whether the send definition suppresses tracking results for associated sends.
TestEmailAddrxsdDefines an email address to which to send a test message as part of an email send definition.Use the Test action when sending a test email to an email send definition.
TimeZoneTimeZoneContains time zone information for an Account. For Create and Update calls, this property defines the time zone for an Account object. On a Retrieve call, TimeZone indicates which time zone is in effect for the Account object in question. Without a specific time zone, the Account defaults to Central Standard Time.
TrackingUsersTrackingUser[]Defines account users with access to tracking information for that send definition.

Methods

NameDescription
CreateCreates an individual object or a batch of objects.
DeleteDeletes an individual object or a batch of objects.
PerformManages asynchronous processes.
RetrieveRetrieves an individual object or a batch of objects.
UpdateUpdates an individual object or a batch of objects.