Send
The Send object sends email and retrieves aggregate data based on a JobID.
- To create a Send using a list, you need the Email | Subscribers | List | SendEmailToList permission.
- To create or update a Send where the list ID is the All Subs List ID, you need the Email | Subscribers | All Subscribers | Send and View permissions.
| Name | Data Type | Description |
|---|---|---|
| Additional | xsd | The ID for a send that customers use as a campaign ID. |
| BccEmail | xsd | Indicates email addresses to receive blind carbon copy of a message. |
| Client | ClientID | Specifies the account ownership and context of an object. |
| CorrelationID | xsd | Identifies correlation of objects across several requests. |
| CreatedDate | xsd | Read-only date and time of the object's creation. |
| CustomerKey | xsd | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
| Duplicates | xsd | Represent the number of duplicate email addresses associated with a send (exists only when a send occurs to multiple lists). |
| Default email address for object. Indicates if subscriber information can be used for email sends. | ||
| EmailName | xsd | Specifies the name of an email message associated with a send. |
| EmailSendDefinition | EmailSendDefinition | Indicates email send definition to which the send object is attached. |
| Events | TrackingEvent[] | Reserved for future use. |
| ExistingUndeliverables | xsd | Indicates whether bounces occurred on previous send. |
| ExistingUnsubscribes | xsd | Indicates whether unsubscriptions occurred on previous send. |
| ForwardedEmails | xsd | Number of emails forwarded for a send. |
| FromAddress | xsd | Indicates From address associated with a object. Deprecated for email send definitions and triggered send definitions. |
| FromName | xsd | Specifies the default email message From Name. Deprecated for email send definitions and triggered send definitions. |
| HardBounces | xsd | Indicates number of hard bounces associated with a send. |
| ID | xsd | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
| InvalidAddresses | xsd | Specifies the number of invalid addresses associated with a send. |
| IsAlwaysOn | xsd | Indicates whether the request can be performed while the system is is maintenance mode. A value of true indicates that the system processes the request. |
| IsMultipart | xsd | Indicates whether the email is sent with Multipart/MIME enabled. |
| Links | Link[] | Contains an array of links included in a send. |
| List | List[] | List associated with an object. |
| MissingAddresses | xsd | Specifies number of missing addresses encountered within a send. |
| ModifiedDate | Nullable`1 | Indicates the last time object information was modified. |
| NumberDelivered | Nullable`1 | Number of sent emails that did not bounce. |
| NumberErrored | xsd | Number of emails not sent as part of a send because an error occurred while trying to build the email. |
| NumberExcluded | xsd | Indicates the number recipients excluded froman email send because of a held, unsubscribed, master unsubscribed, or global unsubscribed status. |
| NumberSent | Nullable`1 | Number of emails actually sent as part of an email send. This number reflects all of the sent messages and may include bounced messages. |
| NumberTargeted | xsd | Indicates the number of possible recipients for an email send. This number does not include unsubscribed or excluded subscribers for a given list or data extension. |
| ObjectID | xsd | System-controlled, read-only text string identifier for object. |
| ObjectState | xsd | Reserved for future use. |
| OtherBounces | xsd | Specifies number of Other-type bounces in a send. |
| Owner | Owner | Describes account ownership of subscriber in an on-your-behalf account. |
| PartnerKey | xsd | Unique identifier provided by partner for an object. This property is accessible only via API. |
| PartnerProperties | APIProperty[] | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
| PreviewURL | xsd | Indicates URL used to preview the message associated with a send. |
| SendDate | xsd | Indicates the date on which a send occurred. Set this value to have a CST (Central Standard Time) value. |
| SendLimit | xsd | Indicates limit of messages to send as part of a send definition within a predefined send window. |
| SendWindowClose | xsd | Defines the end of a send window for a send definition. |
| SendWindowOpen | xsd | Defines the beginning of a send window for a send definition. |
| SentDate | Nullable`1 | Indicates date on which a send took place. |
| SoftBounces | xsd | Indicates number of soft bounces associated with a specific send. |
| Sources | APIObject[] | Specifies multiple sources included in a campaign. |
| Status | xsd | Defines status of object. Status of an address. |
| Subject | xsd | Contains subject area information for a message. |
| SuppressionLists | AudienceItem[] | Array of suppression lists associated with a send. |
| UniqueClicks | xsd | Indicates number of unique clicks on message. |
| UniqueOpens | xsd | Indicates number of unique opens resulting from a triggered send. |
| Unsubscribes | xsd | Indicates the number of unsubscribe events associated with a send. |