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

Retrieve an email deployment sent to a small 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	`EmailLowVolumeDeployment` Note: The activity's email send type will appear as `LowVolumeAPI`.
name	string	The name of the deployment.
contactIds	array	The array of contact ids of the contacts to the deployment will attempt to send to. Contacts that were filtered out during deployment creation because of `sendOptions` are removed from this array and are included in the exclusions array.
exclusions	array	The array of errors describing the reason each contact was excluded from the deployment.
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.
currentStatus	string	Current deployment status.	`normal` `locked` `forceComplete` `inError` `resend`
sendFromUserId	string	The ID of the user used as the sender of the email. Note: If `signatureRuleId` is set, `sendFromUserId` will display the user id of the user who sent the request.
signatureRuleId	string	The ID of the signature rule used if specified on creation.
permissions	array	Permission values of the deployment granted to the current user.
depth	string	The request's level of detail.	`minmal` `partial` `complete`

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.

Nested Schema: sendOptions

Name	Type	Description	Possible values
type	string	The type of send options.	`EmailSendOptions`
allowResend	string	Whether or not this email is allowed to be resent to the contact.
allowSendToMasterExclude	string	Whether or not this email is allowed to be sent to contacts in the master exclude list.
allowSendToUnsubscribe	string	Whether or not this email is allowed to be sent to globally unsubscribed contacts
allowSendToGroupUnsubscribe	string	Whether or not this email is allowed to be sent to contacts unsubscribed from the email group
allowSendToBounceback	string	Whether or not this email is allowed to be sent to contacts that are marked as having bounced.

Example

Retrieve an email deployment with the id = 5 (before the scheduled send time):

GET /assets/email/deployment/5

Response:

{
  "type": "EmailLowVolumeDeployment",
  "currentStatus": "normal",
  "id": "5",
  "depth": "complete",
  "name": "REST Low Volume 01",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update",
    "Activate"
  ],
  "email": {
    "type": "Email",
    "currentStatus": "Draft",
    "id": "101",
    "createdAt": "1468621285",
    "createdBy": "11",
    "depth": "complete",
    "folderId": "42",
    "name": "Test_Low_Volume_Email",
    "permissions": [
      "Retrieve",
      "SetSecurity",
      "Delete",
      "Update"
    ],
    "updatedAt": "1468621363",
    "updatedBy": "11",
    "archive": "false",
    "bounceBackEmail": "APIUserSandbox@s238011564.m.en25.com",
    "contentSections": [],
    "dynamicContents": [],
    "emailFooterId": "1",
    "emailGroupId": "4",
    "emailHeaderId": "1",
    "encodingId": "3",
    "fieldMerges": [],
    "forms": [],
    "htmlContent": {
      "type": "RawHtmlContent",
      "contentSource": "upload",
      "html": "<!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>"
    },
    "hyperlinks": [],
    "images": [],
    "isContentProtected": "false",
    "isPlainTextEditable": "false",
    "isPrivate": "False",
    "isTracked": "true",
    "layout": "{}",
    "plainText": "\r\nTest Low Volume Email\r\n\r\n",
    "renderMode": "Flow",
    "replyToEmail": "api.user@test.oracle.com",
    "replyToName": "API User",
    "sendPlainTextOnly": "false",
    "senderEmail": "api.user@test.oracle.com",
    "senderName": "API User",
    "style": "{}",
    "subject": "Test Low Volume"
  },
  "failedSendCount": "0",
  "successfulSendCount": "0",
  "contactIds": [
    "1",
    "2"
  ],
  "exclusions": [],
  "notificationEmailAddress": "api.user@test.oracle.com",
  "sendDate": "1468622700",
  "sendFromUserId": "11",
  "sendOptions": {
    "type": "EmailSendOptions",
    "allowResend": "true",
    "allowSendToBounceback": "false",
    "allowSendToGroupUnsubscribe": "true",
    "allowSendToMasterExclude": "false",
    "allowSendToUnsubscribe": "false"
  },
  "signatureRuleId": "1"
}

Retrieve an email deployment with the id = 5: (After send time)

GET /assets/email/deployment/5

Response:

{
  "type": "EmailLowVolumeDeployment",
  "currentStatus": "normal",
  "id": "5",
  "depth": "complete",
  "name": "REST Low Volume 01",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update",
    "Activate"
  ],
  "email": {
    "type": "Email",
    "currentStatus": "Draft",
    "id": "101",
    "createdAt": "1468621285",
    "createdBy": "11",
    "depth": "complete",
    "folderId": "42",
    "name": "Test_Low_Volume_Email",
    "permissions": [
      "Retrieve",
      "SetSecurity",
      "Delete",
      "Update"
    ],
    "updatedAt": "1468621363",
    "updatedBy": "11",
    "archive": "false",
    "bounceBackEmail": "APIUserSandbox@s238011564.m.en25.com",
    "contentSections": [],
    "dynamicContents": [],
    "emailFooterId": "1",
    "emailGroupId": "4",
    "emailHeaderId": "1",
    "encodingId": "3",
    "fieldMerges": [],
    "forms": [],
    "htmlContent": {
      "type": "RawHtmlContent",
      "contentSource": "upload",
      "html": "<!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>"
    },
    "hyperlinks": [],
    "images": [],
    "isContentProtected": "false",
    "isPlainTextEditable": "false",
    "isPrivate": "False",
    "isTracked": "true",
    "layout": "{}",
    "plainText": "\r\nTest Low Volume Email\r\n\r\n",
    "renderMode": "Flow",
    "replyToEmail": "api.user@test.oracle.com",
    "replyToName": "API User",
    "sendPlainTextOnly": "false",
    "senderEmail": "api.user@test.oracle.com",
    "senderName": "API User",
    "style": "{}",
    "subject": "Test Low Volume"
  },
  "endAt": "1468622701",
  "failedSendCount": "0",
  "successfulSendCount": "2",
  "contactIds": [
    "1",
    "2"
  ],
  "exclusions": [],
  "notificationEmailAddress": "api.user@test.oracle.com",
  "sendDate": "1468622700",
  "sendFromUserId": "11",
  "sendOptions": {
    "type": "EmailSendOptions",
    "allowResend": "true",
    "allowSendToBounceback": "false",
    "allowSendToGroupUnsubscribe": "true",
    "allowSendToMasterExclude": "false",
    "allowSendToUnsubscribe": "false"
  },
  "signatureRuleId": "1"
}

Retrieve an email deployment with the id = 5 at minimal depth:

GET /assets/email/deployment/5?depth=minimal

Response:

{
  "type": "EmailLowVolumeDeployment",
  "id": "5",
  "depth": "minimal",
  "name": "REST Low Volume 01",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update",
    "Activate"
  ],
  "failedSendCount": "0",
  "successfulSendCount": "2",
  "exclusions": []
}

Retrieve an email deployment with the ID = 5 at partial depth:

GET /assets/email/deployment/5?depth=partial

Response:

{
  "type": "EmailLowVolumeDeployment",
  "currentStatus": "normal",
  "id": "5",
  "depth": "partial",
  "name": "REST Low Volume 01",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update",
    "Activate"
  ],
  "email": {
    "type": "Email",
    "currentStatus": "Draft",
    "id": "101",
    "createdAt": "1468621285",
    "createdBy": "11",
    "depth": "partial",
    "folderId": "42",
    "name": "Test_Low_Volume_Email",
    "permissions": [
      "Retrieve",
      "SetSecurity",
      "Delete",
      "Update"
    ],
    "updatedAt": "1468621363",
    "updatedBy": "11",
    "archive": "false",
    "bounceBackEmail": "APIUserSandbox@s238011564.m.en25.com",
    "emailFooterId": "1",
    "emailGroupId": "4",
    "emailHeaderId": "1",
    "encodingId": "3",
    "fieldMerges": [],
    "htmlContent": {
      "type": "RawHtmlContent",
      "contentSource": "upload"
    },
    "hyperlinks": [],
    "isContentProtected": "false",
    "isPlainTextEditable": "false",
    "isPrivate": "False",
    "isTracked": "true",
    "layout": "{}",
    "plainText": "\r\nTest Low Volume Email\r\n\r\n",
    "renderMode": "Flow",
    "replyToEmail": "api.user@test.oracle.com",
    "replyToName": "API User",
    "sendPlainTextOnly": "false",
    "senderEmail": "api.user@test.oracle.com",
    "senderName": "API User",
    "style": "{}",
    "subject": "Test Low Volume"
  },
  "endAt": "1468622701",
  "failedSendCount": "0",
  "successfulSendCount": "2",
  "contactIds": [
    "1",
    "2"
  ],
  "exclusions": [],
  "notificationEmailAddress": "api.user@test.oracle.com",
  "sendDate": "1468622700",
  "sendFromUserId": "11",
  "sendOptions": {
    "type": "EmailSendOptions",
    "allowResend": "true",
    "allowSendToBounceback": "false",
    "allowSendToGroupUnsubscribe": "true",
    "allowSendToMasterExclude": "false",
    "allowSendToUnsubscribe": "false"
  },
  "signatureRuleId": "1"
}

Learn more

Email deployment API

Application API