EmailSendDefinition

An object that contains the content, sender profile, delivery profile, and audience information for a classic Email Studio message.

To manage Content Builder emails, use the Assets endpoints in REST API.

To create an email send definition with a send definition list where the value of DataSourceTypeID is List and the value of SendDefinitionListType is SourceList, you need the Email | Subscribers | List | SendEmailToList permission. To create or update an email send definition with a send definition list where the ID is the All Subs List, you need the Email | Subscribers | All Subscribers | SendEmailToList and View permissions. To start or test an email send definition using the Perform method, you need the Email | Content | Email | Send or Test Send permissions.

Name	Data Type	Description
`Additional`	String	The 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.
`AutoBccEmail`	String	Defines blind carbon copy email address to which to send a message as part of an email send definition.
`BccEmail`	String	Indicates 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 doesn’t error out if feature isn’t enabled. The API returns no tracking information for BCC emails. You must specify this property in an email send definition. You can’t specify this property at send time. However, you can create a profile attribute for this property and pass in a value at send time.
`CategoryID`	Int	Specifies the identifier of the folder.
`CCEmail`	String	Carbon copy email address. You must specify the CCEmail property in an email send definition, as you can’t specify this property at send time. You can create a profile attribute for this property and pass in a value at send time, however.
`Client`	ClientID 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.
`DeduplicateByEmail`	Boolean	Indicates 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.
`DeliveryProfile`	DeliveryProfile object	Identifies the delivery profile included in a send classification.
`DeliveryScheduledTime`	DateTime	Defines scheduled data and time for a send related to an email send definition.
`Description`	String	Describes and provides information regarding the object.
`DomainType`	DeliveryProfileDomainTypeEnum	Defines the type of domain associated with a delivery profile or send definition. Valid values include DefaultDomain or CustomDomain.
`DynamicEmailSubject`	String	Contains content to be used in a dynamic subject line.
`Email`	Email object	Default email address for object. Indicates if subscriber information can be used for email sends.
`EmailSubject`	String	Subject 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.
`ExclusionFilter`	String	Contains 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.
`FooterContentArea`	ContentArea	Defines footer content area to use as part of a delivery profile or send definition.
`FooterSalutationSource`	SalutationSourceEnum	Defines source of a footer salutation to use as part of a delivery profile or send definition. Valid values include: Default Content Library None
`FromAddress`	String	Indicates From address associated with a object. Deprecated for email send definitions and triggered send definitions.
`FromName`	String	Specifies the default email message From Name. Deprecated for email send definitions and triggered send definitions.
`HeaderContentArea`	ContentArea	Defines content area to be used in the header of a delivery profile or a send definition.
`HeaderSalutationSource`	SalutationSourceEnum	Defines source of header salutation for a delivery profile or send definition. Valid values include: Default Content Library None
`ID`	Int	Read-only identifier for an object. Some objects use the ObjectID property as a unique ID.
`InteractionObjectID`	String	Returns associated ID for activities within the asynchronous process of the overall conversation or program.
`IsMultipart`	Boolean	Indicates whether the email is sent with Multipart/MIME enabled.
`IsSeedListSend`	Boolean	Indicates whether a email send includes the use of a seed list.
`IsSendLogging`	Boolean	Indicates whether send logging is enabled for the specified send definition.
`IsWrapped`	Boolean	Indicates whether an email send contains the links necessary to process tracking information for clicks.
`Keyword`	String	Not used.
`MessageDeliveryType`	MessageDeliveryTypeEnum	Enumerates 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
`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 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.
`PartnerProperties`	Array of APIProperty objects	A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
`PreHeader`	String	Contains text used in preheader of email message on mobile devices.
`PrivateDomain`	PrivateDomain object	Defines private domain to use as part of a delivery profile or send definition.
`PrivateIP`	PrivateIP object	Contains information about the private IP address associated with a delivery profile.
`ReplyToAddress`	String	Specifies the reply address used for any messages sent using this send definition.
`ReplyToDisplayName`	String	Optional value that specifies the display name for the email address contained in the ReplyToAddress property.
`SeedListOccurance`	Int	Property definition.
`SendClassification`	SendClassification object	Indicates the send classification to use as part of a send definition. This field is required when updating a user-initiated send definition.
`SendDefinitionList`	Array of SendDefinitionList objects	Indicates the subscriber list to use as part of an email send definition.
`SenderProfile`	SenderProfile object	Identifies the sender profile included in the send classification.
`SendLimit`	Int	Indicates limit of messages to send as part of a send definition within a predefined send window.
`SendWindowClose`	DateTime	Defines the end of a send window for a send definition.
`SendWindowDelete`	Boolean	Indicates whether an existing send window for a send definition is deleted.
`SendWindowOpen`	DateTime	Defines the beginning of a send window for a send definition.
`SourceAddressType`	DeliveryProfileSourceAddressTypeEnum	Indicates the source IP address type used with the delivery profile. Valid values include DefaultPrivateIPAddress and CustomPrivateIPAddress.
`SuppressTracking`	Boolean	Indicates whether the send definition suppresses tracking results for associated sends.
`TestEmailAddr`	String	Defines 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.
`TimeZone`	TimeZone object	Contains 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.
`TrackingUsers`	Array of TrackingUser objects	Defines account users with access to tracking information for that send definition.

Name	Description
Create	Creates an individual object or a batch of objects.
Delete	Deletes an individual object or a batch of objects.
Perform	Manages asynchronous processes.
Retrieve	Retrieves an individual object or a batch of objects.
Update	Updates an individual object or a batch of objects.