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

Retrieve an email deployment sent to one contact.

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.

  • minmal
  • partial
  • complete

Response parameters

Name

Type

Description

Possible values

type

string The type of email deployment EmailTestDeployment

Note: The activity's Email Send Type will appear as QuickSend.

name

string

The name of the deployment  
contactId string The contact ID of the contact to send to  
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  
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 = 4:

GET /assets/email/deployment/4

Response:

{
  "type": "EmailTestDeployment",
  "currentStatus": "normal",
  "id": "4",
  "depth": "complete",
  "name": "REST Test 01",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update",
    "Activate"
  ],
  "email": {
    "type": "Email",
    "currentStatus": "Draft",
    "id": "100",
    "createdAt": "1468620389",
    "createdBy": "11",
    "depth": "complete",
    "folderId": "42",
    "name": "Test_Email",
    "permissions": [
      "Retrieve",
      "SetSecurity",
      "Delete",
      "Update"
    ],
    "updatedAt": "1468620436",
    "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 Email</p>\r\n  </body> \r\n</html>"
    },
    "hyperlinks": [],
    "images": [],
    "isContentProtected": "false",
    "isPlainTextEditable": "false",
    "isPrivate": "False",
    "isTracked": "true",
    "layout": "{}",
    "plainText": "\r\nTest 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"
  },
  "endAt": "1468620440",
  "failedSendCount": "0",
  "successfulSendCount": "1",
  "contactId": "1",
  "sendOptions": {
    "type": "EmailSendOptions",
    "allowResend": "true",
    "allowSendToBounceback": "false",
    "allowSendToGroupUnsubscribe": "true",
    "allowSendToMasterExclude": "false",
    "allowSendToUnsubscribe": "false"
  }
}