GET api/REST/2.0/assets/email/deployment/{id}

Retrieve an email deployment sent to a large number of contacts.

Request parameters

Required

Name	Type	Description	Possible values
id	integer	Unique identifier of the email deployment.

Optional

Name	Type	Description	Possible values
depth	string	Level of detail returned by the request. The default will be complete. Learn more about the depth parameter.	`minimal` `partial` `complete`

Response parameters

Name	Type	Description	Possible values
type	string	The type of email deployment.	`EmailInlineDeployment` Note: The activity's Email Send Type will appear as `SalesTools`.
currentStatus	string	Current deployment status.	`normal` `locked` `forceComplete` `inError` `resend`
id	string	The ID of the email asset
depth	string	The request's level of detail.	`complete`
name	string	The name of the deployment.
permissions	array	Permission values of the deployment granted to the current user.
successfulSendCount	string	The number of emails which have been successfully sent so far.
failedSendCount	string	The number of emails which failed during send so far.
sendDate	string	The date the deployment was scheduled for send. The format is Unix Time. If scheduled for a future date, the email will be deployed at the future date and time. Otherwise the email will be sent right away.
sentContent	string	The contents of the email sent.
sentSubject	string	The email subject.
successfulSendCount	string	The amount of email deployments sent successfully to contacts.
clickthroughCount	string	The count of user clickthroughs recorded on the email.
contacts	array	The array of contact ids of the contacts to the deployment will attempt to send to. Note: For a full list of parameters returned within the contact object see Retrieve a contact response parameters.
externalSource	string	Indicates the source of the email. If not specified, set to `Unknown`.	`Unknown` `Engage` `SalesCloud`
openCount	string	The count of user email opens for the email.
sendFromUserId	string	The ID of the user used as the sender of the email.
statistics	array	Statistics about the email deployment such as bounceback type, clickthrough count, email open date, and email send date.

Nested Schema: email

Name	Type	Description	Possible values
type	string	The asset's type in Eloqua	`Email`
id	string	The ID of the email asset
name	string	The name of the email asset

Note: For a full list of parameters returned within the email object see Retrieve an email response parameters.

Example

Retrieve an email deployment with the id = 10:

GET /assets/email/deployment/10

Response:

{
  "type": "EmailInlineDeployment",
  "currentStatus": "normal",
  "id": "10",
  "depth": "complete",
  "name": "Email Send Future Date",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update",
    "Activate"
  ],
  "email": {
    "type": "Email",
    "replyToEmail": "api.user@oracle.com",
    "replyToName": "New Client",
    "senderEmail": "api.user@oracle.com",
    "senderName": "New Client"
  },
  "endAt": "1604439829",
  "failedSendCount": "0",
  "sentContent": "<!DOCTYPE html> \r\n<html>\r\n  <head>  </head>\r\n  <body>\r\n    <p>Test Low Volume Email</p>\r\n  </body> \r\n</html>",
  "sentSubject": "test email send",
  "successfulSendCount": "1",
  "clickthroughCount": "0",
  "contacts": [
    {
      "type": "Contact",
      "currentStatus": "Awaiting action",
      "id": "4",
      "createdAt": "1424720465",
      "depth": "partial",
      "name": "api.user@oracle.com",
      "updatedAt": "1600783263",
      "emailAddress": "api.user@oracle.com",
      "emailFormatPreference": "unspecified",
      "firstName": "api",
      "isBounceback": "false",
      "isSubscribed": "true",
      "lastName": "user",
      "subscriptionDate": "1424720465"
    }
  ],
  "openCount": "1",
  "sendFromUserId": "2",
  "statistics": [
    {
      "type": "EmailDeploymentStatistic",
      "bouncebackType": "",
      "clickthroughCount": "3",
      "contactId": "4",
      "emailAddress": "api.user@oracle.com",
      "openCount": "1",
      "sentAt": "1604439828"
    }
  ]
}

Learn more

Email deployment API

Application API