Create and send an email deployment

post

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

Sends an email to a single contact or a low volume of contacts (up to 100 contacts). See Email deployment API in the Oracle Eloqua Developer Help Center for complete information about this endpoint. Email properties cannot be modified via this endpoint.

Request

Supported Media Types
Query Parameters
  • Whether or not the email header and footer is inserted into the email body. If true, the email header and footer will not be inserted into the email body. If false, the email header and footer will be inserted into the email body.
Body ()
The request body defines the details of the email deployment to be created.
Root Schema : EmailDeployment
Type: object
Title: EmailDeployment
Show Source
Nested Schema : Email
Type: object
Title: Email
Show Source
Nested Schema : permissions
Type: array
Permission values of the deployment granted to the current user.
Show Source
Nested Schema : attachments
Type: array
A list of imported files.
Show Source
Nested Schema : contentSections
Type: array
A list of content sections contained within the email.
Show Source
Nested Schema : contentServiceInstances
Type: array
Show Source
Nested Schema : dynamicContents
Type: array
A list of dynamic contents contained within the email.
Show Source
Nested Schema : fieldMerges
Type: array
A list of associated Field Merges.
Show Source
Nested Schema : files
Type: array
A list of imported files.
Show Source
Nested Schema : forms
Type: array
A list of associated Form assets.
Show Source
Nested Schema : HtmlContent
Type: object
Title: HtmlContent
Show Source
Nested Schema : images
Type: array
A list of associated Image assets.
Show Source
Nested Schema : permissions
Type: array
The permissions for the email granted to your current instance. This is a read-only property.
Show Source
Nested Schema : ImportedFile
Type: object
Title: ImportedFile
Show Source
Nested Schema : permissions
Type: array
The permissions for the imported file granted to your current instance.
Show Source
Nested Schema : ContentSection
Type: object
Title: ContentSection
Show Source
Nested Schema : files
Type: array
A list of associated files.
Show Source
Nested Schema : forms
Type: array
A list of associated Form assets.
Show Source
Nested Schema : images
Type: array
A list of associated Image assets.
Show Source
Nested Schema : permissions
Type: array
The permissions for the content section granted to your current instance. This is a read-only property.
Show Source
Nested Schema : Size
Type: object
Title: Size
Show Source
Nested Schema : Form
Type: object
Title: Form
Show Source
Nested Schema : FormFieldUpdateMapping
Type: object
Title: FormFieldUpdateMapping
Show Source
Nested Schema : elements
Type: array
Array consisting of form elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the form granted to your current instance. This is a read-only property.
Show Source
Nested Schema : processingSteps
Type: array
A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, and FormStepWebTracking.
Show Source
Nested Schema : permissions
Type: array
The permissions for the form field update mapping granted to your current instance. This is a read-only property.
Show Source
Nested Schema : FormElement
Type: object
Title: FormElement
Show Source
Nested Schema : permissions
Type: array
The permissions for the form element granted to your current instance.
Show Source
Nested Schema : FormProcessingStep
Type: object
Title: FormProcessingStep
Show Source
Nested Schema : ProcessingStepCondition
Type: object
Title: ProcessingStepCondition
Show Source
Nested Schema : permissions
Type: array
The permissions for the form processing step granted to your current instance.
Show Source
Nested Schema : conditionalFieldCriteria
Type: array
The conditional field criteria for the form processing step condition.
Show Source
Nested Schema : FieldComparisonCriteria
Type: object
Title: FieldComparisonCriteria
Show Source
Nested Schema : Condition
Type: object
Title: Condition
Show Source
Nested Schema : permissions
Type: array
The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
Show Source
Nested Schema : Hyperlink
Type: object
Title: Hyperlink
Show Source
Nested Schema : permissions
Type: array
The permissions for the hyperlink granted to your current instance.
Show Source
Nested Schema : ImageFile
Type: object
Title: ImageFile
Show Source
Nested Schema : permissions
Type: array
The permissions for the image granted to your current instance. This is a read-only property.
Show Source
Nested Schema : CloudComponentInstance
Type: object
Title: CloudComponentInstance
Show Source
Nested Schema : DynamicContent
Type: object
Title: DynamicContent
Show Source
Nested Schema : permissions
Type: array
The permissions for the dynamic content granted to your current instance. This is a read-only property.
Show Source
Nested Schema : rules
Type: array
The dynamic content's rules.
Show Source
Nested Schema : DynamicContentRule
Type: object
Title: DynamicContentRule
Show Source
Nested Schema : criteria
Type: array
The criteria of the dynamic content rule.
Show Source
Nested Schema : Criterion
Type: object
Title: Criterion
Show Source
Nested Schema : permissions
Type: array
The permissions for the criterion granted to your current instance.
Show Source
Nested Schema : FieldMerge
Type: object
Title: FieldMerge
Show Source
Nested Schema : fieldConditions
Type: array
Array of field condition fields.
Show Source
Nested Schema : permissions
Type: array
The permissions for the field merge granted to your current instance.
Show Source
Nested Schema : FieldCondition
Type: object
Title: FieldCondition
Show Source
Nested Schema : permissions
Type: array
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success
Body ()
Root Schema : EmailDeployment
Type: object
Title: EmailDeployment
Show Source
Nested Schema : Email
Type: object
Title: Email
Show Source
Nested Schema : permissions
Type: array
Permission values of the deployment granted to the current user.
Show Source
Nested Schema : attachments
Type: array
A list of imported files.
Show Source
Nested Schema : contentSections
Type: array
A list of content sections contained within the email.
Show Source
Nested Schema : contentServiceInstances
Type: array
Show Source
Nested Schema : dynamicContents
Type: array
A list of dynamic contents contained within the email.
Show Source
Nested Schema : fieldMerges
Type: array
A list of associated Field Merges.
Show Source
Nested Schema : files
Type: array
A list of imported files.
Show Source
Nested Schema : forms
Type: array
A list of associated Form assets.
Show Source
Nested Schema : HtmlContent
Type: object
Title: HtmlContent
Show Source
Nested Schema : images
Type: array
A list of associated Image assets.
Show Source
Nested Schema : permissions
Type: array
The permissions for the email granted to your current instance. This is a read-only property.
Show Source
Nested Schema : ImportedFile
Type: object
Title: ImportedFile
Show Source
Nested Schema : permissions
Type: array
The permissions for the imported file granted to your current instance.
Show Source
Nested Schema : ContentSection
Type: object
Title: ContentSection
Show Source
Nested Schema : files
Type: array
A list of associated files.
Show Source
Nested Schema : forms
Type: array
A list of associated Form assets.
Show Source
Nested Schema : images
Type: array
A list of associated Image assets.
Show Source
Nested Schema : permissions
Type: array
The permissions for the content section granted to your current instance. This is a read-only property.
Show Source
Nested Schema : Size
Type: object
Title: Size
Show Source
Nested Schema : Form
Type: object
Title: Form
Show Source
Nested Schema : FormFieldUpdateMapping
Type: object
Title: FormFieldUpdateMapping
Show Source
Nested Schema : elements
Type: array
Array consisting of form elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the form granted to your current instance. This is a read-only property.
Show Source
Nested Schema : processingSteps
Type: array
A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, and FormStepWebTracking.
Show Source
Nested Schema : permissions
Type: array
The permissions for the form field update mapping granted to your current instance. This is a read-only property.
Show Source
Nested Schema : FormElement
Type: object
Title: FormElement
Show Source
Nested Schema : permissions
Type: array
The permissions for the form element granted to your current instance.
Show Source
Nested Schema : FormProcessingStep
Type: object
Title: FormProcessingStep
Show Source
Nested Schema : ProcessingStepCondition
Type: object
Title: ProcessingStepCondition
Show Source
Nested Schema : permissions
Type: array
The permissions for the form processing step granted to your current instance.
Show Source
Nested Schema : conditionalFieldCriteria
Type: array
The conditional field criteria for the form processing step condition.
Show Source
Nested Schema : FieldComparisonCriteria
Type: object
Title: FieldComparisonCriteria
Show Source
Nested Schema : Condition
Type: object
Title: Condition
Show Source
Nested Schema : permissions
Type: array
The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
Show Source
Nested Schema : Hyperlink
Type: object
Title: Hyperlink
Show Source
Nested Schema : permissions
Type: array
The permissions for the hyperlink granted to your current instance.
Show Source
Nested Schema : ImageFile
Type: object
Title: ImageFile
Show Source
Nested Schema : permissions
Type: array
The permissions for the image granted to your current instance. This is a read-only property.
Show Source
Nested Schema : CloudComponentInstance
Type: object
Title: CloudComponentInstance
Show Source
Nested Schema : DynamicContent
Type: object
Title: DynamicContent
Show Source
Nested Schema : permissions
Type: array
The permissions for the dynamic content granted to your current instance. This is a read-only property.
Show Source
Nested Schema : rules
Type: array
The dynamic content's rules.
Show Source
Nested Schema : DynamicContentRule
Type: object
Title: DynamicContentRule
Show Source
Nested Schema : criteria
Type: array
The criteria of the dynamic content rule.
Show Source
Nested Schema : Criterion
Type: object
Title: Criterion
Show Source
Nested Schema : permissions
Type: array
The permissions for the criterion granted to your current instance.
Show Source
Nested Schema : FieldMerge
Type: object
Title: FieldMerge
Show Source
Nested Schema : fieldConditions
Type: array
Array of field condition fields.
Show Source
Nested Schema : permissions
Type: array
The permissions for the field merge granted to your current instance.
Show Source
Nested Schema : FieldCondition
Type: object
Title: FieldCondition
Show Source
Nested Schema : permissions
Type: array
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

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


POST /api/REST/2.0/assets/email/deployment
Content-Type: application/json 
			

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"
    }
}
			

Create and send an email deployment for an existing email asset to two contacts:


POST /assets/email/deployment
Content-Type: application/json 
			

Request body:


{
    "type": "EmailLowVolumeDeployment",
    "name": "REST Low Volume 01",
    "contactIds": [
        "1",
        "2"
    ],
    "email": {
        "type": "Email",
        "id": "101",
        "name": "test01"
    },
    "signatureRuleId": "1",
    "notificationEmailAddress": "api.user@test.oracle.com",
    "sendDate": "1468622700",
    "sendOptions": {
        "allowResend": "true",
        "allowSendToUnsubscribe": "false"
    }
}
			

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"
    ],
    "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"
}
			
Back to Top