TriggeredSendDefinition

Defines a triggered send in the account.

  • To create or update a TriggeredSendDefinition where the list ID is the All Subs List ID, you need the Email | Subscribers | All Subscribers | View and SendEmailToList permissions.
  • To update a TriggeredSendDefinition where the TriggeredSendStatus is Active, Moved, Inactive, or Canceled, you need the Email | Interactions | Messages | Email | Triggered | Start, Move, Pause, or Archive permissions, respectively.
  • To update a TriggeredSendDefinition where RefreshContent is enabled, you need the Email | Interactions | Messages | Email | Triggered | Publish Changes permission.
NameData TypeDescription
AllowedSlotsShortReserved for future use.
AutoAddSubscribersBooleanIndicates whether a triggered send recipient is added to a subscriber list. If set to True, the call automatically adds the email address associated with the triggered send to a specified subscriber list.
AutoUpdateSubscribersBooleanIndicates if any subscriber information is updated as part of a triggered send. If set to True, the triggered send call updates any applicable subscriber information with information from the send.
BatchIntervalIntDeprecated.
BccEmailStringIndicates email addresses to receive blind carbon copy of a message. This property allows access to the BCC feature. if enabled on the account. The API returns no tracking information for BCC emails and doesn't error out if the BCC feature is disabled. You can’t specify this property at send time. Either specify the BccEmail in a triggered send or email send definition, or create a profile attribute and pass in a value at send time.
CategoryIDIntSpecifies the identifier of the folder.
CCEmailStringCarbon copy email address. You can’t specify this property at send time. Either specify the CCEmail in a triggered send or email send definition, or create a profile attribute and pass in a value at send time.
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.
DisableOnEmailBuildErrorBooleanIndicates whether an email send continues or not after reaching an error threshold specified by Marketing Cloud Engagement. This property corresponds to a checkbox. Contact your Account Executive to change the threshold. The error threshold defaults to 10.
DomainTypeDeliveryProfileDomainTypeEnumDefines the type of domain (DefaultDomain or CustomDomain) associated with a delivery profile or send definition.
DynamicEmailSubjectStringContains content to be used in a dynamic subject line.
EmailEmailRefers to the Email object representing the email used in the send.
EmailSubjectStringSubject for an email send.
ExclusionFilterStringContains a string of AMPscript that can evaluate to true or false. Use this property to exclude email addresses from a send definition that match that string value. This property can cause performance issues with send time for large amounts of email addresses. Use the data filter function instead.
ExclusionListCollectionArray of TriggeredSendExclusionList objectsSpecifies one or many exclusion lists.
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.
IsAlwaysOnBooleanIndicates whether the request can be performed while the system is maintenance mode. A value of true indicates that the system processes the request.
IsMultipartBooleanIndicates whether the email is sent with Multipart/MIME enabled.
IsSendLoggingBooleanIndicates whether send logging is enabled for the specified send definition.
IsWrappedBooleanIndicates whether an email send contains the links necessary to process tracking information for clicks.
KeywordStringReserved for future use.
ListListList associated with an object.
ModifiedDateDateTimeThe date and time when the object was last modified.
NameStringName of the object or property.
NewSlotTriggerIntDeprecated.
ObjectIDStringSystem-controlled, read-only text string identifier for object.
ObjectStateStringReserved for future use.
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.
PreHeaderStringContains text used in preheader of email message on mobile devices.
PriorityStringDefines the priority for a triggered send. Valid values include Low, Medium, and High.
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.
RefreshContentBooleanIndicates whether the triggered send definition refreshes content as part of the send. A value of true indicates that the triggered send contains refreshed content.
ReplyToAddressStringSpecifies the reply address used for any messages sent using this send definition.
ReplyToDisplayNameStringOptional value that specifies the display name for the email address contained in the ReplyToAddress property.
SendClassificationSendClassificationIndicates the send classification to use as part of a send definition.
SenderProfileSenderProfileIdentifies the sender profile included in the send classification.
SendLimitIntIndicates limit of messages to send as part of a send definition within a predefined send window.
SendSourceCustomerKeyStringDeprecated.
SendSourceDataExtensionDataExtensionIndicates the data extension used as the source of information for a triggered send definition.
SendWindowCloseDateTimeDefines the end of a send window for a send definition.
SendWindowDeleteBooleanIndicates whether an existing send window for a send definition is deleted.
SendWindowOpenDateTimeDefines 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.
SuppressTrackingBooleanIndicates whether the send definition suppresses tracking results for associated sends.
TriggeredSendClassTriggeredSendClassEnumIndicates usage of the triggered send for standard API sends or SMTPRestV2 SMTP relay sends.
TriggeredSendStatusTriggeredSendStatusEnumRepresent status of triggered send. Valid values include:
  • New (Same as New in UI)
  • Inactive (Same as Paused in UI)
  • Active (Same as Running in UI)
  • Canceled (Same as Archived in UI)
  • Deleted (Not displayed in UI)
TriggeredSendSubClassTriggeredSendSubClassEnumIndicates if and how a template applies to SMTPRestV2 SMTP relay sends.
TriggeredSendTypeTriggeredSendTypeEnumDeprecated.