POST api/REST/2.0/assets/email/deployment

Send an email to a single contact. This quick send endpoint is used to create and send an email deployment for an existing email asset to a single contact.

Request parameters

Required

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.  

Nested schema: email

The email to send. The selected email cannot be modified as part of an email deployment request.

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: The name is not actually read so any value can be used but it is still required.

 

 

Optional

Name

Type

Description

Possible values

sendFromUserId string The ID of the user to use as the sender of the email. The default will use the current user.  

Nested Schema: sendOptions

Name

Type

Description

Possible values

allowResend string Allow resending this email asset to the contact. The default will be true.  
allowSendToMasterExclude string Allow sending to contacts in the master exclude list. The default will be false.  
allowSendToUnsubscribe string Allow sending to globally unsubscribed contacts. The default will be false.  
allowSendToGroupUnsubscribe string Allow sending to contacts unsubscribed from the email group. The default will be true.  
allowSendToBounceback string Allow sending to contacts that are marked as having bounced. The default will be false.  

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

Create and send an email deployment for an existing email asset to a single contact:

POST /assets/email/deployment

Request body:

{
  "type": "EmailTestDeployment",
  "name": "REST Test 01",
  "contactId":  "1",
  "email": {
    "type": "Email",
    "id": "100",
    "name": "test01"
  },
  "sendOptions": {
    "allowResend": "true",
    "allowSendToUnsubscribe": "false"
  }
}

Response:

{
  "type": "EmailTestDeployment",
  "currentStatus": "normal",
  "id": "4",
  "depth": "complete",
  "name": "REST Test 01",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update",
    "Activate"
  ],
  "email": {
    "type": "Email",
    "x_e10_previewUrl": "https://p03.eloquapreview.com/Preview.aspx?siteId=238011564&userGuid=a2475311-77bb-41e6-9db1-45c8c6402efa",
    "x_e10_previewExpiryDate": "1468620740",
    "x_e10_isTemplate": "false",
    "x_e10_createdAt": "1468620436",
    "x_e10_createdBy": "11",
    "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"
  },
  "failedSendCount": "0",
  "successfulSendCount": "0",
  "contactId": "1",
  "sendOptions": {
    "type": "EmailSendOptions",
    "allowResend": "true",
    "allowSendToBounceback": "false",
    "allowSendToGroupUnsubscribe": "true",
    "allowSendToMasterExclude": "false",
    "allowSendToUnsubscribe": "false"
  }
}