Oracle Eloqua Application/2.0/Email deployment API

openapi: 3.2.0
info:
  title: REST API for Oracle Eloqua Marketing Cloud Service Application/2.0/Email deployment API
  description: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers.
  version: 2026.08.07
  x-summary: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers.
tags:
- name: Application/2.0/Email deployment
  description: 'The email deployment API is used to send and retrieve email deployments. There are two methods for creating and sending email deployments: to a single contact, or to a low volume of contacts (up to 100 contacts).


    <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAA/index.html#CSHID=Emails''>Learn more about emails</a>.'
paths:
  /api/rest/2.0/assets/email/deployment:
    post:
      operationId: CreateIndividualPOSTRest20
      parameters:
      - name: preMerge
        in: query
        description: 'Whether or not the email header and footer is inserted into the email body. If <code>true</code>, the email header and footer will not be inserted into the email body. If <code>false</code>, the email header and footer will be inserted into the email body. '
        required: false
        schema:
          type: boolean
      summary: Create and send an email deployment
      description: Sends an email to a single contact or a low volume of contacts (up to 100 contacts). See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=EmailDeployment'>Email deployment API</a> in the <i>Oracle Eloqua Developer Help Center</i> for complete information about this endpoint. Email properties cannot be modified via this endpoint.
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDeploymentRest20'
        '400':
          description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '401':
          description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '403':
          description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '404':
          description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '500':
          description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
      tags:
      - Application/2.0/Email deployment
      x-internal-id: api-rest-2.0-assets-email-deployment-post
      x-filename-id: api-rest-2.0-assets-email-deployment-post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailDeploymentRest20'
        description: The request body defines the details of the email deployment to be created.
        required: true
  /api/rest/2.0/assets/email/deployment/{id}:
    get:
      operationId: ReadIndividualGETRest20
      parameters:
      - name: id
        in: path
        description: Id of the email deployment.
        required: true
        schema:
          type: integer
      - name: depth
        in: query
        description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>. Any other values passed are reset to complete by default.'
        required: false
        schema:
          type: string
      summary: Retrieve an email deployment
      description: Retrieves information about an email deployment.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDeploymentRest20'
        '400':
          description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '401':
          description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '403':
          description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '404':
          description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '500':
          description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
      tags:
      - Application/2.0/Email deployment
      x-internal-id: api-rest-2.0-assets-email-deployment-{id}-get
      x-filename-id: api-rest-2.0-assets-email-deployment-id-get
components:
  schemas:
    CriterionRest20:
      title: Criterion
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
        id:
          type: string
          readOnly: true
          description: Id of the criterion. This is a read-only property.
        currentStatus:
          type: string
          description: The criterion's current status. This is a read-only property.
        name:
          type: string
          description: Name of the criterion.
        description:
          type: string
          description: The description of the criterion.
        permissions:
          type: array
          description: The permissions for the criterion granted to your current instance.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: Id of the folder. This is a read-only property.
        sourceTemplateId:
          type: string
          description: Id of the source template. This is a read-only property.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the criterion.
        createdByName:
          type: string
          description: The name of the user who created the criterion.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the criterion was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the criterion.
        updatedByName:
          type: string
          description: The name of the user who last updated the criterion.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the criterion was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: The date and time the criterion is scheduled for.
        depth:
          type: string
          readOnly: true
          description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
    System.Nullable_1__System.Int32__mscorlib__Version_4.0.0.0__Culture_neutral__PublicKeyToken_b77a5c561934e089__Rest20:
      title: System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
      properties: {}
    EmailDeploymentRest20:
      title: EmailDeployment
      properties:
        type:
          type: string
          description: "The type of email deployment. Possible values include: \n<ul>\n<li><code>EmailTestDeployment</code></li>\n<li><code>EmailLowVolumeDeployment</code></li>\n</ul>\n\nNote that the activity's Email Send Type will appear as <code>QuickSend</code>."
        id:
          type: string
          readOnly: true
          description: Unique identifier of the email deployment.
        currentStatus:
          type: string
          description: 'Current deployment status. Possible values are: <code>normal</code>, <code>locked</code>, <code>forceComplete</code>, <code>inError</code>, or <code>resend</code>.'
        name:
          type: string
          description: The name of the deployment.
        description:
          type: string
          description: Description of the deployment.
        permissions:
          type: array
          description: Permission values of the deployment granted to the current user.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: Id of the folder.
        sourceTemplateId:
          type: string
          description: Id of the source template.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the email deployment.
        createdByName:
          type: string
          description: The name of the user who created the email deployment.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the email deployment was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the email deployment.
        updatedByName:
          type: string
          description: The name of the user who last updated the email deployment.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the email deployment was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: The date and time the email deployment is scheduled.
        depth:
          type: string
          readOnly: true
          description: The request's level of detail.
        email:
          $ref: '#/components/schemas/EmailRest20'
          description: Information about the email asset. Email properties cannot be modified via this endpoint.
        successfulSendCount:
          type: string
          readOnly: true
          description: The number of emails which have been successfully sent so far.
        failedSendCount:
          type: string
          readOnly: true
          description: The number of emails which failed during send so far.
        endAt:
          type: string
          readOnly: true
          description: The date and time the email deployment ended.
        sentContent:
          type: string
          description: The content type of the email.
        sentSubject:
          type: string
          description: The subject line of the email.
        sendDate:
          type: string
          description: EmailDeployment_Field_SendDate_Description
    FormElementRest20:
      title: FormElement
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
        id:
          type: string
          readOnly: true
          description: The ID of the form element. This is a read-only property.
        currentStatus:
          type: string
          description: The form element's current status.
        name:
          type: string
          description: Name of the form element.
        description:
          type: string
          description: The description of the form element.
        permissions:
          type: array
          description: The permissions for the form element granted to your current instance.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: The ID of the associated folder.
        sourceTemplateId:
          type: string
          description: The ID of the form element.
        createdBy:
          type: string
          readOnly: true
          description: The login ID of the user who created the form element.
        createdByName:
          type: string
          description: The name of the user who created the form element.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the form element was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login ID of the user that last updated the form element.
        updatedByName:
          type: string
          description: The name of the user who last updated the form element.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the form element was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: The date the form element is scheduled.
        depth:
          type: string
          readOnly: true
          description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'' target=''_blank''>Request depth</a>.'
        instructions:
          type: string
          description: The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
        style:
          type: string
          description: The asset's main layout style.
    FieldConditionRest20:
      title: FieldCondition
      properties:
        type:
          type: string
        id:
          type: string
          readOnly: true
        currentStatus:
          type: string
        name:
          type: string
        description:
          type: string
        permissions:
          type: array
          items:
            type: string
        folderId:
          type: string
          readOnly: true
        sourceTemplateId:
          type: string
        createdBy:
          type: string
          readOnly: true
        createdByName:
          type: string
        createdAt:
          type: string
          readOnly: true
        updatedBy:
          type: string
          readOnly: true
        updatedByName:
          type: string
        updatedAt:
          type: string
          readOnly: true
        scheduledFor:
          type: string
          readOnly: true
        depth:
          type: string
          readOnly: true
        condition:
          $ref: '#/components/schemas/ConditionRest20'
        fieldId:
          type: string
    FieldMergeRest20:
      title: FieldMerge
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
        id:
          type: string
          readOnly: true
          description: Id of the field merge. This is a read-only property.
        currentStatus:
          type: string
          description: The field merge's current status.
        name:
          type: string
          description: Name of the field merge.
        description:
          type: string
          description: The description of the field merge.
        permissions:
          type: array
          description: The permissions for the field merge granted to your current instance.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: Id of the associated folder.
        sourceTemplateId:
          type: string
          description: The id of the source template.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the field merge.
        createdByName:
          type: string
          description: The name of the user who created the field merge.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the field merge was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the field merge.
        updatedByName:
          type: string
          description: The name of the user who last updated the field merge.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the field merge was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used for field merges.
        depth:
          type: string
          readOnly: true
          description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        syntax:
          type: string
          description: The syntax of the field merge.
        defaultValue:
          type: string
          description: The default value of the field merge.
        contactFieldId:
          type: string
          description: Id of the associated contact field.
        accountFieldId:
          type: string
          description: Id of the associated account field.
        eventId:
          type: string
          description: Id of the associated event.
        eventFieldId:
          type: string
          description: Id of the associated event field.
        eventSessionFieldId:
          type: string
          description: Id of the associated event session field.
        customObjectId:
          type: string
          description: Id of the associated custom object.
        customObjectFieldId:
          type: string
          description: Id of the associated custom object field.
        mergeType:
          type: string
          description: 'Type of the field merge. Possible values include: <code>contactField</code>, <code>accountField</code>, <code>eventField</code>, <code>eventSessionField</code>, and <code>customObjectField</code>.'
        customObjectSort:
          type: string
          description: The associated custom object sort type.
        queryStringKey:
          type: string
          description: 'The key value if the field merge contains a query string. See the <a href=''https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/Help/FieldMerges/Tasks/CreatingFieldMergeWithQueryString.htm''>Help Center</a> to learn more about field merges with query strings. This is a read-only property. '
        fieldConditions:
          type: array
          description: Array of field condition fields.
          items:
            $ref: '#/components/schemas/FieldConditionRest20'
        allowUrlsInValue:
          type: string
          description: Whether or not URLs are allowed in this field merge. False by default. Using URLs in a field merge can be a security risk. By default, when Oracle Eloqua attempts to insert the field merge, it removes any URLs while still inserting the remaining data. However, you can override this security feature by selecting the Allow URLs in field merge check box in the Eloqua user interface.
    EmailRest20:
      title: Email
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
        id:
          type: string
          readOnly: true
          description: Id of the email. This is a read-only property.
        currentStatus:
          type: string
          description: The asset's current status. This is a read-only property.
        name:
          type: string
          description: The name of the email.
        description:
          type: string
          description: The description of the email.
        permissions:
          type: array
          description: The permissions for the email granted to your current instance. This is a read-only property.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: Id of the folder.
        sourceTemplateId:
          type: string
          description: Id of the source template.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the email.
        createdByName:
          type: string
          description: The name of the user who created the email.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the email was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the email.
        updatedByName:
          type: string
          description: The name of the user who last updated the email.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the email was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: The date and time the email is scheduled for.
        depth:
          type: string
          readOnly: true
          description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        subject:
          type: string
          description: The email's subject line text.
        previewText:
          type: string
          description: The preheader text that email clients will use when displaying a preview of the email. 500 character limit. Different email clients will limit the amount of characters displayed.
        senderName:
          type: string
          description: The sender name recipients of the email will see.
        senderEmail:
          type: string
          description: The address the email will appear to be sent from.
        replyToName:
          type: string
          description: The sender name recipients of the email will see.
        replyToEmail:
          type: string
          description: The email address targeted when recipients click "reply".
        bounceBackEmail:
          type: string
          description: The email address which is notified if the email is undeliverable.
        virtualMTAId:
          type: string
          description: The numeric ID for the Virtual MTA configuration. Virtual MTAs are setup during the Branding and Deliverability package provisioning process. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAA/index.html#CSHID=EmailSettings'>the Oracle Eloqua Help Center</a>.
        brandId:
          type: string
          description: The email's brand ID.
        htmlContent:
          $ref: '#/components/schemas/HtmlContentRest20'
          description: The email's content in HTML.
        plainText:
          type: string
          description: The email's content in plain text.
        isPlainTextEditable:
          type: string
          description: Whether or not the asset's text is editable.
        sendPlainTextOnly:
          type: string
          description: Whether or not the sent email is plain text only.
        isTracked:
          type: string
          description: Whether or not Eloqua will track the asset.
        isPrivate:
          type: string
          description: Whether or not the email is private.
        layout:
          type: string
          description: The email's main layout.
        style:
          type: string
          description: The email's main layout style.
        forms:
          type: array
          description: A list of associated Form assets.
          items:
            $ref: '#/components/schemas/FormRest20'
        images:
          type: array
          description: A list of associated Image assets.
          items:
            $ref: '#/components/schemas/ImageFileRest20'
        hyperlinks:
          type: array
          description: A list of hyperlinks contained within the email.
          items:
            $ref: '#/components/schemas/HyperlinkRest20'
        contentSections:
          type: array
          description: A list of content sections contained within the email.
          items:
            $ref: '#/components/schemas/ContentSectionRest20'
        dynamicContents:
          type: array
          description: A list of dynamic contents contained within the email.
          items:
            $ref: '#/components/schemas/DynamicContentRest20'
        files:
          type: array
          description: A list of imported files.
          items:
            $ref: '#/components/schemas/ImportedFileRest20'
        contentServiceInstances:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/CloudComponentInstanceRest20'
        emailHeaderId:
          type: string
          description: Id of the email header.
        emailFooterId:
          type: string
          description: Id of the email footer.
        emailGroupId:
          type: string
          description: Id of the email group.
        encodingId:
          type: string
          description: Id of the encoding used.
        fieldMerges:
          type: array
          description: A list of associated Field Merges.
          items:
            $ref: '#/components/schemas/FieldMergeRest20'
        attachments:
          type: array
          description: A list of imported files.
          items:
            $ref: '#/components/schemas/ImportedFileRest20'
        isContentProtected:
          type: string
          description: Whether or not the email is in protected mode.
        renderMode:
          type: string
          description: 'The layout of the email when it is sent or previewed. Possible values include: <code>fixed</code> or <code>flow</code>.'
        archived:
          type: string
          description: Whether or not the email is archived.
        thumbnailUrl:
          type: string
          description: Email_Field_ThumbnailUrl_Description
    DynamicContentRuleRest20:
      title: DynamicContentRule
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
        currentStatus:
          type: string
          description: The Dynamic Content Rule 's current status.
        id:
          type: string
          description: Id of the dynamic content rule. This is a read-only property.
        depth:
          type: string
          description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        contentSection:
          $ref: '#/components/schemas/ContentSectionRest20'
          description: A list of associated Content Section assets.
        criteria:
          type: array
          description: The criteria of the dynamic content rule.
          items:
            $ref: '#/components/schemas/CriterionRest20'
        statement:
          type: string
          description: The statement of the dynamic content rule.
        name:
          type: string
          description: The name of the dynamic content rule.
    FieldComparisonCriteriaRest20:
      title: FieldComparisonCriteria
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
        id:
          type: string
          readOnly: true
          description: Id of the field comparison criteria.
        currentStatus:
          type: string
          description: The field comparison criteria's current status.
        name:
          type: string
          description: The name of the field comparison criteria.
        description:
          type: string
          description: The description of the field comparison criteria.
        permissions:
          type: array
          description: The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: Id of the folder. This is a read-only property.
        sourceTemplateId:
          type: string
          description: Id of the source template. This is a read-only property.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the field comparison criteria.
        createdByName:
          type: string
          description: The name of the user who created the field comparison criteria.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the field comparison criteria was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the field comparison criteria.
        updatedByName:
          type: string
          description: The name of the user who last updated the field comparison criteria.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the field comparison criteria was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: The date and time the field comparison criteria is scheduled.
        depth:
          type: string
          readOnly: true
          description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        fieldId:
          type: string
          description: The id of the field comparison criteria.
        condition:
          $ref: '#/components/schemas/ConditionRest20'
          description: The condition of the field

# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eloqua/refs/heads/main/openapi/eloqua-application-2-0-email-deployment-api-openapi.yml