Sends email or retrieves data for completed sends.
Properties
| Name | Data Type | Description |
|---|---|---|
Additional |
String | The ID for a send that customers use as a campaign ID. |
BccEmail |
String | The email addresses that receive blind carbon copy of a message. |
Client |
ClientID object | An object that specifies the account ownership and context of an object. |
CorrelationID |
String | An ID that correlates objects across several requests. |
CreatedDate |
Datetime | The date and time when the object was created. |
CustomerKey |
String | A user-supplied unique identifier for an object. This property corresponds to the external key assigned to an object. |
Duplicates |
Integer | The number of duplicate email addresses associated with a send. This property exists only when a send targets multiple lists. |
Email |
Email object | The default email address for the send object. |
EmailName |
String | Specifies the name of an email message associated with a send. |
EmailSendDefinition |
EmailSendDefinition object | The email send definition that the send object is attached to. |
Events |
Array of TrackingEvent objects | Not used. |
ExistingUndeliverables |
Integer | The number of bounces that occurred on previous send. |
ExistingUnsubscribes |
Integer | The number of unsubscribe events that occurred in previous sends. |
ForwardedEmails |
Integer | The number of emails forwarded. |
FromAddress |
String | The From address for the send. For email send definitions and triggered send definitions, this property is deprecated. |
FromName |
String | The default email message From name. For email send definitions and triggered send definitions, this property is deprecated. |
HardBounces |
Integer | The number of hard bounces associated with a send. |
ID |
Integer | A read-only, unique identifier for an object. Some objects use the ObjectID property as a unique ID. |
InvalidAddresses |
Integer | The number of invalid addresses associated with a send. |
IsAlwaysOn |
Boolean | Indicates whether the request can be performed while the system is in maintenance mode. A value of true indicates that the system processes the request. |
IsMultipart |
Boolean | Indicates whether the email was sent with Multipart/MIME enabled. |
Links |
Array of Link objects | An array of links included in a send. |
List |
Array of List objects | An array of lists associated with the send object. |
MissingAddresses |
Integer | The number of missing addresses encountered in a send. |
ModifiedDate |
Datetime | The date and time when the object was last modified. |
NumberDelivered |
Integer | The number of sent emails that didn't bounce. |
NumberErrored |
Integer | The number of emails that weren't sent because an error occurred while trying to build the email. |
NumberExcluded |
Integer | The number recipients that were excluded from an email send because of a held, unsubscribed, or global unsubscribed status. |
NumberSent |
Integer | The number of emails sent as part of an email send. This number includes messages that bounced. |
NumberTargeted |
Integer | The number of possible recipients for an email send. This number doesn't include unsubscribed or excluded subscribers for a given list or data extension. |
ObjectID |
String | A system-controlled, read-only unique identifier for the send object. |
ObjectState |
String | Not used. |
OtherBounces |
Integer | The number of other bounces in a send. |
Owner |
Owner object | An object that describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey |
String | A 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. |
PreviewURL |
String | The URL that can be used to preview the message associated with a send. |
SendDate |
Datetime | The date and time when a send occurred. Set this value to have a CST (Central Standard Time) value. |
SendLimit |
Integer | The maximum number of messages to send as part of a send definition within a predefined send window. |
SendWindowClose |
Datetime | The date on which a send window for a send definition ends. |
SendWindowOpen |
Datetime | The date on which a send window for a send definition ends. |
SentDate |
Datetime | The date on which a send took place. |
SoftBounces |
Integer | The number of soft bounces associated with a specific send. |
Sources |
Array of APIObject objects | An array of objects that specify multiple sources included in a campaign. |
Status |
String | The status of an address. |
Subject |
String | The subject line for the send. |
SuppressionLists |
Array of AudienceItem objects | An array of suppression lists associated with the send. |
UniqueClicks |
Integer | The number of unique clicks for a message. |
UniqueOpens |
Integer | The number of unique opens resulting from the triggered send. |
Unsubscribes |
Integer | The number of unsubscribe events associated with the send. |
When you use this object to perform a send, it returns an email ID. This ID corresponds to the data.email.legacyData.legacyId property for Content Builder assets.