Retrieve a list of emails
get
/api/rest/2.0/assets/emails
Retrieves all emails that match the criteria specified by the request parameters.
Request
Supported Media Types
- application/json
Query Parameters
-
count: integer
Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
-
depth: string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal
,partial
, andcomplete
. Any other values passed are reset tominimal
by default. -
includeArchived: boolean
Specifies whether to include archived emails in the results, considered false if not specified.
-
includeAvailable: boolean
Specifies whether to include unarchived emails in the results, considered true if not specified.
-
lastUpdatedAt: integer
The date and time the email was last updated.
-
orderBy: string
Specifies the field by which list results are ordered.
-
page: integer
Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
-
search: string
Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : QueryResultEmail
Type:
object
Title:
Show Source
QueryResultEmail
-
elements:
array elements
Array of email data.
-
page:
integer
The specified page.
-
pageSize:
integer
The page size.
-
total:
integer
The total amount of results.
-
type:
string
The asset's type in Eloqua.
Nested Schema : elements
Type:
array
Array of email data.
Show Source
-
Array of:
object Email
Title:
Email
Nested Schema : Email
Type:
object
Title:
Show Source
Email
-
archived:
string
Whether or not the email is archived.
-
attachments:
array attachments
A list of imported files.
-
bounceBackEmail:
string
The email address which is notified if the email is undeliverable.
-
brandId:
string
The email's brand ID.
-
contentSections:
array contentSections
A list of content sections contained within the email.
-
contentServiceInstances:
array contentServiceInstances
-
createdAt:
string
Read Only:
true
The date and time the email was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the email. -
createdByName:
string
The name of the user who created the email.
-
currentStatus:
string
The asset's current status. This is a read-only property.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the email.
-
dynamicContents:
array dynamicContents
A list of dynamic contents contained within the email.
- emailFooterId: string
-
emailGroupId:
string
Id of the email group.
-
emailHeaderId:
string
Id of the email header.
-
encodingId:
string
Id of the encoding used.
-
fieldMerges:
array fieldMerges
A list of associated Field Merges.
-
files:
array files
A list of imported files.
-
folderId:
string
Read Only:
true
Id of the folder. -
forms:
array forms
A list of associated Form assets.
-
htmlContent:
object HtmlContent
Title:
HtmlContent
-
hyperlinks:
array hyperlinks
A list of hyperlinks contained within the email.
-
id:
string
Read Only:
true
Id of the email. This is a read-only property. -
images:
array images
A list of associated Image assets.
-
isContentProtected:
string
Whether or not the email is in protected mode.
-
isPlainTextEditable:
string
Whether or not the asset's text is editable.
-
isPrivate:
string
Whether or not the email is private.
-
isTracked:
string
Whether or not Eloqua will track the asset.
-
layout:
string
The email's main layout.
-
name:
string
The name of the email.
-
permissions:
array permissions
The permissions for the email granted to your current instance. This is a read-only property.
-
plainText:
string
The email's content in plain text.
-
previewText:
string
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.
-
renderMode:
string
The layout of the email when it is sent or previewed. Possible values include:
fixed
orflow
. -
replyToEmail:
string
The email address targeted when recipients click "reply".
-
replyToName:
string
The sender name recipients of the email will see.
-
scheduledFor:
string
Read Only:
true
The date and time the email is scheduled for. -
senderEmail:
string
The address the email will appear to be sent from.
-
senderName:
string
The sender name recipients of the email will see.
-
sendPlainTextOnly:
string
Whether or not the sent email is plain text only.
-
sourceTemplateId:
string
Id of the source template.
-
style:
string
The email's main layout style.
-
subject:
string
The email's subject line text.
-
thumbnailUrl:
string
Email_Field_ThumbnailUrl_Description
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the email was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the email. -
updatedByName:
string
The name of the user who last updated the email.
-
virtualMTAId:
string
The numeric ID for the Virtual MTA configuration. Virtual MTAs are setup during the Branding and Deliverability package provisioning process. For more information, see the Oracle Eloqua Help Center.
Nested Schema : attachments
Type:
array
A list of imported files.
Show Source
-
Array of:
object ImportedFile
Title:
ImportedFile
Nested Schema : contentSections
Type:
array
A list of content sections contained within the email.
Show Source
-
Array of:
object ContentSection
Title:
ContentSection
Nested Schema : contentServiceInstances
Type:
Show Source
array
-
Array of:
object CloudComponentInstance
Title:
CloudComponentInstance
Nested Schema : dynamicContents
Type:
array
A list of dynamic contents contained within the email.
Show Source
-
Array of:
object DynamicContent
Title:
DynamicContent
Nested Schema : fieldMerges
Type:
array
A list of associated Field Merges.
Show Source
-
Array of:
object FieldMerge
Title:
FieldMerge
Nested Schema : files
Type:
array
A list of imported files.
Show Source
-
Array of:
object ImportedFile
Title:
ImportedFile
Nested Schema : forms
Type:
array
A list of associated Form assets.
Show Source
-
Array of:
object Form
Title:
Form
Nested Schema : hyperlinks
Type:
array
A list of hyperlinks contained within the email.
Show Source
-
Array of:
object Hyperlink
Title:
Hyperlink
Nested Schema : images
Type:
array
A list of associated Image assets.
Show Source
-
Array of:
object ImageFile
Title:
ImageFile
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:
Show Source
ImportedFile
-
brandId:
string
ImportedFile_Field_BrandId_Description
-
createdAt:
string
Read Only:
true
The date and time the imported file was last accessed, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the imported file. -
createdByName:
string
The name of the user who created the imported file.
-
currentStatus:
string
The imported file's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the imported file.
-
fileName:
string
The file name of the imported file.
-
folderId:
string
Read Only:
true
Id of the folder. This is a read-only property. -
id:
string
Read Only:
true
Id of the imported file. This is a read-only property. -
link:
string
The imported file's complete URL. This is a read-only property.
-
name:
string
Name of the imported file.
-
permissions:
array permissions
The permissions for the imported file granted to your current instance.
-
redirectLink:
string
The imported file's redirect URL. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date and time the file is scheduled for. This is a read-only property. -
sourceTemplateId:
string
Id of the source template. This is a read-only property.
-
trackedLink:
string
The imported file's tracked complete URL. This is a read-only property.
-
type:
string
The date and time the imported file was last accessed. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the imported file was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the imported file. -
updatedByName:
string
The name of the user who last updated the imported file.
Nested Schema : permissions
Type:
array
The permissions for the imported file granted to your current instance.
Show Source
Nested Schema : ContentSection
Type:
object
Title:
Show Source
ContentSection
-
contentHtml:
string
The content section's HTML content.
-
contentText:
string
The content section's text content.
-
createdAt:
string
Read Only:
true
The date and time the content section was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the content section. -
createdByName:
string
The name of the user who created the content section.
-
currentStatus:
string
The content section's current status. This is a read-only property.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the content section.
-
files:
array files
A list of associated files.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the content section. -
forms:
array forms
A list of associated Form assets.
-
hyperlinks:
array hyperlinks
A list of hyperlinks contained within the content section.
-
id:
string
Read Only:
true
Id of the content section. This is a read-only property. -
images:
array images
A list of associated Image assets.
-
name:
string
The name of the content section.
-
permissions:
array permissions
The permissions for the content section granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date the content section is scheduled. This is a read-only property. -
scope:
string
The content sections's scope: either local or global.
-
size:
object Size
Title:
Size
-
sourceTemplateId:
string
Id of the template used to create the asset.
-
type:
string
The content section's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the content section was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the content section. -
updatedByName:
string
The name of the user who last updated the content section.
Nested Schema : files
Type:
array
A list of associated files.
Show Source
-
Array of:
object ImportedFile
Title:
ImportedFile
Nested Schema : forms
Type:
array
A list of associated Form assets.
Show Source
-
Array of:
object Form
Title:
Form
Nested Schema : hyperlinks
Type:
array
A list of hyperlinks contained within the content section.
Show Source
-
Array of:
object Hyperlink
Title:
Hyperlink
Nested Schema : images
Type:
array
A list of associated Image assets.
Show Source
-
Array of:
object ImageFile
Title:
ImageFile
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:
Show Source
Size
-
height:
string
The height dimensions of the asset expressed in pixels.
-
type:
string
The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'.
-
width:
string
The width dimensions of the asset expressed in pixels.
Nested Schema : Form
Type:
object
Title:
Show Source
Form
-
archived:
string
True if form is archived otherwise False. This is a read-only property.
-
createdAt:
string
Read Only:
true
The date and time the form was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login ID of the user who created the form. -
createdByName:
string
The name of the user who created the form.
-
currentStatus:
string
The form's current status. Example: draft, active, or complete.
-
customCSS:
string
The custom style applied to the form.
-
defaultKeyFieldMapping:
object FormFieldUpdateMapping
Title:
FormFieldUpdateMapping
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the form.
-
elements:
array elements
Array consisting of form elements.
-
externalIntegrationUrl:
string
The external integration URL used for integrating external forms.
-
folderId:
string
Read Only:
true
The ID of the containing folder. -
formJson:
string
Form metadata in JSON. Applicable only to responsive forms. Not required to be set when creating and updating forms. We recommend omitting this parameter when creating and updating forms, and letting Eloqua set it by default. When creating a form and including this parameter, this must be set to
{\"type\":\"responsiveForm\",\"version\":\"1\"}
. -
html:
string
The asset's raw HTML content.
-
htmlName:
string
The asset's raw HTML name.
-
id:
string
Read Only:
true
Id of the form. -
isFormSpamProtectionEnabled:
string
Indicates whether spam protection is enabled on the form.
-
isHidden:
string
Whether the form is an internal form. If true, the form is not exposed outside of Eloqua and any form submissions to this form are deleted.
-
isResponsive:
string
Indicates whether the form is responsive. Returns
true
for a responsive form,false
for a legacy form. Avoid sending this property when creating and updating forms. This is a read-only property. -
name:
string
The name of the form.
-
permissions:
array permissions
The permissions for the form granted to your current instance. This is a read-only property.
-
processingSteps:
array processingSteps
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, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.
-
processingType:
string
A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.
-
scheduledFor:
string
Read Only:
true
This property is not used. -
size:
object Size
Title:
Size
-
sourceTemplateId:
string
Id of the source template.
-
style:
string
The asset's main layout style.
-
submitFailedLandingPageId:
string
The landing page ID of the failed submit.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form was last updated. -
updatedBy:
string
Read Only:
true
The login ID of the user that last updated the form. -
updatedByName:
string
The name of the user who last updated the form.
Nested Schema : FormFieldUpdateMapping
Type:
object
Title:
Show Source
FormFieldUpdateMapping
-
createdAt:
string
Read Only:
true
The date and time the form field update mapping was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the form field update mapping. -
createdByName:
string
The name of the user who created the form field update mapping.
-
currentStatus:
string
The form field update mapping's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the field comparison criteria.
-
folderId:
string
Read Only:
true
Id of the folder. This is a read-only property. -
id:
string
Read Only:
true
Id of the form field update mapping. -
name:
string
The name of the form field update mapping.
-
permissions:
array permissions
The permissions for the form field update mapping granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date and time the form field update mapping is scheduled. -
sourceFormFieldId:
string
Id of the source form field.
-
sourceTemplateId:
string
Id of the source template. This is a read-only property.
-
targetEntityFieldId:
string
Id of the target field.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form field update mapping was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the form field update mapping. -
updatedByName:
string
The name of the user who last updated the form field update mapping.
-
updateType:
string
The update type of the form field update mapping.
Nested Schema : elements
Type:
array
Array consisting of form elements.
Show Source
-
Array of:
object FormElement
Title:
FormElement
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, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.
Show Source
-
Array of:
object FormProcessingStep
Title:
FormProcessingStep
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:
Show Source
FormElement
-
createdAt:
string
Read Only:
true
The date and time the form element was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login ID of the user who created the form element. -
createdByName:
string
The name of the user who created the form element.
-
currentStatus:
string
The form element's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the form element.
-
folderId:
string
Read Only:
true
The ID of the associated folder. -
id:
string
Read Only:
true
The ID of the form element. This is a read-only property. -
instructions:
string
The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
-
name:
string
Name of the form element.
-
permissions:
array permissions
The permissions for the form element granted to your current instance.
-
scheduledFor:
string
Read Only:
true
The date the form element is scheduled. -
sourceTemplateId:
string
The ID of the form element.
-
style:
string
The asset's main layout style.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form element was last updated. -
updatedBy:
string
Read Only:
true
The login ID of the user that last updated the form element. -
updatedByName:
string
The name of the user who last updated the form element.
Nested Schema : permissions
Type:
array
The permissions for the form element granted to your current instance.
Show Source
Nested Schema : FormProcessingStep
Type:
object
Title:
Show Source
FormProcessingStep
-
condition:
object ProcessingStepCondition
Title:
ProcessingStepCondition
-
createdAt:
string
Read Only:
true
The date and time the form processing step was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login ID of the user who created the form processing step. -
createdByName:
string
The name of the user who created the form processing step.
-
currentStatus:
string
The form processing step's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the form processing step.
-
execute:
string
The conditions for which this form processing step will execute. Possible values include:
always
,conditionally
, andnever
. -
folderId:
string
Read Only:
true
Id of the associated folder. -
hasValidationIssue:
string
ProcessingStep_Field_HasValidationIssue_Description
-
id:
string
Read Only:
true
Id of the form processing step. This is a read-only property. -
name:
string
Name of the form processing step.
-
permissions:
array permissions
The permissions for the form processing step granted to your current instance.
-
scheduledFor:
string
Read Only:
true
The date the form processing step is scheduled. -
sourceTemplateId:
string
The ID of the source template.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form processing step was last updated. -
updatedBy:
string
Read Only:
true
The login ID of the user that last updated the form processing step. -
updatedByName:
string
The name of the user who last updated the form processing step.
Nested Schema : ProcessingStepCondition
Type:
object
Title:
Show Source
ProcessingStepCondition
-
conditionalFieldCriteria:
array conditionalFieldCriteria
The conditional field criteria for the form processing step condition.
-
isConditionallyNegated:
string
The conditions for which the processing step will execute. If yes, the processing step will execute when the conditions are met. If no, the processing step will execute when the conditions are not met.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
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
-
Array of:
object FieldComparisonCriteria
Title:
FieldComparisonCriteria
Nested Schema : FieldComparisonCriteria
Type:
object
Title:
Show Source
FieldComparisonCriteria
-
condition:
object Condition
Title:
Condition
-
createdAt:
string
Read Only:
true
The date and time the field comparison criteria was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the field comparison criteria. -
createdByName:
string
The name of the user who created the field comparison criteria.
-
currentStatus:
string
The field comparison criteria's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the field comparison criteria.
-
fieldId:
string
The id of the field comparison criteria.
-
folderId:
string
Read Only:
true
Id of the folder. This is a read-only property. -
id:
string
Read Only:
true
Id of the field comparison criteria. -
name:
string
The name of the field comparison criteria.
-
permissions:
array permissions
The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date and time the field comparison criteria is scheduled. -
sourceTemplateId:
string
Id of the source template. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the field comparison criteria was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the field comparison criteria. -
updatedByName:
string
The name of the user who last updated the field comparison criteria.
Nested Schema : Condition
Type:
object
Title:
Show Source
Condition
-
type:
string
The asset's type in Eloqua. This is a read-only property.
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:
Show Source
Hyperlink
-
createdAt:
string
Read Only:
true
The date and time the hyperlink was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the hyperlink. -
createdByName:
string
The name of the user who created the hyperlink.
-
currentStatus:
string
The hyperlink's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the hyperlink.
-
folderId:
string
Read Only:
true
Id of the containing folder. -
href:
string
Href value of the hyperlink.
-
hyperlinkType:
string
The type of hyperlink. Possible values include:
ExternalURL
,ICSCalendarURL
,LandingPageURL
,ReferrerURL
,RSSURL
, orTrackedExternalURL
. -
id:
string
Read Only:
true
Id of the hyperlink. This is a read-only property. -
name:
string
Name of the hyperlink.
-
permissions:
array permissions
The permissions for the hyperlink granted to your current instance.
-
referencedEntityId:
string
Id of the referenced entity.
-
scheduledFor:
string
Read Only:
true
The date the hyperlink is scheduled. -
sourceTemplateId:
string
Id of the source template.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the hyperlink was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the hyperlink. -
updatedByName:
string
The name of the user who last updated the hyperlink.
Nested Schema : permissions
Type:
array
The permissions for the hyperlink granted to your current instance.
Show Source
Nested Schema : ImageFile
Type:
object
Title:
Show Source
ImageFile
-
createdAt:
string
Read Only:
true
The date and time the image was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the image. -
createdByName:
string
The name of the user who created the image.
-
currentStatus:
string
The image's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the image.
-
folderId:
string
Read Only:
true
Id of the folder. -
fullImageUrl:
string
The image's complete URL. This is a read-only property.
-
id:
string
Read Only:
true
Id of the image. -
name:
string
The name of the image.
-
permissions:
array permissions
The permissions for the image granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date and time the image is scheduled. -
size:
object Size
Title:
Size
-
source:
string
The image's source location.
-
sourceTemplateId:
string
Id of the source template.
-
syncDate:
string
The date and time the image was last synced, expressed in Unix time. This is a read-only property.
-
thumbnailUrl:
string
The image's thumbnail URL. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the image was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the image. -
updatedByName:
string
The name of the user who last updated the image.
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:
Show Source
CloudComponentInstance
-
appStatus:
string
The status of the cloud content. Possible values include:
Up
,Down
, andMaintenance
. -
componentId:
string
The component id of the cloud content.
-
configurationUrl:
string
Read Only:
true
The configuration URL for the cloud content. -
configurationUrlModalSize:
string
The modal size of the configuration window. Possible values are
large
orsmall
. -
editorImageUrl:
string
The image url for an image that Eloqua will display in the editor's design surface.
editorImageUrl
is not a templated URL. -
enabledConfigStatus:
string
Whether or not the cloud content is configured. Possible values include:
None
,Installing
,EnableProcess
,Error
,Ready
,Disabled
,DisabledError
,MarkedForDeletion
. -
height:
Title:
System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
-
id:
string
The cloud content's unique identifier.
-
requiresConfiguration:
string
Whether user configuration is required before the cloud content can be used. If set to
true
, users will be unable to save an email or landing page asset containing the unconfigured app service instance. Eloqua will display an error message. -
type:
string
The asset's type in Eloqua.
-
width:
Title:
System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Nested Schema : DynamicContent
Type:
object
Title:
Show Source
DynamicContent
-
createdAt:
string
Read Only:
true
The date and time the dynamic content was last accessed, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the dynamic content. -
createdByName:
string
The name of the user who created the dynamic content.
-
currentStatus:
string
The dynamic content's current status.
-
defaultContentSection:
object ContentSection
Title:
ContentSection
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the dynamic content.
-
folderId:
string
Read Only:
true
The id of the associated folder. -
id:
string
Read Only:
true
Id of the dynamic content. This is a read-only property. -
isContentPublic:
boolean
Whether or not the dynamic content is public.
-
name:
string
Name of the dynamic content.
-
permissions:
array permissions
The permissions for the dynamic content granted to your current instance. This is a read-only property.
-
rules:
array rules
The dynamic content's rules.
-
scheduledFor:
string
Read Only:
true
The date the dynamic content is scheduled. -
sourceTemplateId:
string
The id of the source template.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the dynamic content was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the dynamic content. -
updatedByName:
string
The name of the user who last updated the dynamic content.
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
-
Array of:
object DynamicContentRule
Title:
DynamicContentRule
Nested Schema : DynamicContentRule
Type:
object
Title:
Show Source
DynamicContentRule
-
contentSection:
object ContentSection
Title:
ContentSection
-
criteria:
array criteria
The criteria of the dynamic content rule.
-
currentStatus:
string
The Dynamic Content Rule 's current status.
-
depth:
string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
id:
string
Id of the dynamic content rule. This is a read-only property.
-
name:
string
The name of the dynamic content rule.
-
statement:
string
The statement of the dynamic content rule.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : criteria
Type:
array
The criteria of the dynamic content rule.
Show Source
-
Array of:
object Criterion
Title:
Criterion
Nested Schema : Criterion
Type:
object
Title:
Show Source
Criterion
-
createdAt:
string
Read Only:
true
The date and time the criterion was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the criterion. -
createdByName:
string
The name of the user who created the criterion.
-
currentStatus:
string
The criterion's current status. This is a read-only property.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the criterion.
-
folderId:
string
Read Only:
true
Id of the folder. This is a read-only property. -
id:
string
Read Only:
true
Id of the criterion. This is a read-only property. -
name:
string
Name of the criterion.
-
permissions:
array permissions
The permissions for the criterion granted to your current instance.
-
scheduledFor:
string
Read Only:
true
The date and time the criterion is scheduled for. -
sourceTemplateId:
string
Id of the source template. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the criterion was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the criterion. -
updatedByName:
string
The name of the user who last updated the criterion.
Nested Schema : permissions
Type:
array
The permissions for the criterion granted to your current instance.
Show Source
Nested Schema : FieldMerge
Type:
object
Title:
Show Source
FieldMerge
-
accountFieldId:
string
Id of the associated account field.
-
allowUrlsInValue:
string
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.
-
contactFieldId:
string
Id of the associated contact field.
-
createdAt:
string
Read Only:
true
The date and time the field merge was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the field merge. -
createdByName:
string
The name of the user who created the field merge.
-
currentStatus:
string
The field merge's current status.
-
customObjectFieldId:
string
Id of the associated custom object field.
-
customObjectId:
string
Id of the associated custom object.
-
customObjectSort:
string
The associated custom object sort type.
-
defaultValue:
string
The default value of the field merge.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the field merge.
-
eventFieldId:
string
Id of the associated event field.
-
eventId:
string
Id of the associated event.
-
eventSessionFieldId:
string
Id of the associated event session field.
-
fieldConditions:
array fieldConditions
Array of field condition fields.
-
folderId:
string
Read Only:
true
Id of the associated folder. -
id:
string
Read Only:
true
Id of the field merge. This is a read-only property. -
mergeType:
string
Type of the field merge. Possible values include:
contactField
,accountField
,eventField
,eventSessionField
, andcustomObjectField
. -
name:
string
Name of the field merge.
-
permissions:
array permissions
The permissions for the field merge granted to your current instance.
-
queryStringKey:
string
The key value if the field merge contains a query string. See the Help Center to learn more about field merges with query strings. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
This property is not used for field merges. -
sourceTemplateId:
string
The id of the source template.
-
syntax:
string
The syntax of the field merge.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the field merge was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the field merge. -
updatedByName:
string
The name of the user who last updated the field merge.
Nested Schema : fieldConditions
Type:
array
Array of field condition fields.
Show Source
-
Array of:
object FieldCondition
Title:
FieldCondition
Nested Schema : permissions
Type:
array
The permissions for the field merge granted to your current instance.
Show Source
Nested Schema : FieldCondition
Type:
object
Title:
Show Source
FieldCondition
-
condition:
object Condition
Title:
Condition
-
createdAt:
string
Read Only:
true
-
createdBy:
string
Read Only:
true
-
createdByName:
string
-
currentStatus:
string
-
depth:
string
Read Only:
true
-
description:
string
-
fieldId:
string
-
folderId:
string
Read Only:
true
-
id:
string
Read Only:
true
-
name:
string
-
permissions:
array permissions
-
scheduledFor:
string
Read Only:
true
-
sourceTemplateId:
string
-
type:
string
-
updatedAt:
string
Read Only:
true
-
updatedBy:
string
Read Only:
true
-
updatedByName:
string
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.
Examples
The following examples demonstrate how to retrieve emails using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Examples
Retrieve the first 2 unarchived emails in your database. By default only unarchived emails are returned.
GET /api/REST/2.0/assets/emails?count=2
Response:
{
"elements": [
{
"type": "Email",
"currentStatus": "Draft",
"id": "168",
"createdAt": "1505993096",
"createdBy": "35",
"depth": "minimal",
"folderId": "4195",
"name": "Sample-HTML-Email.html",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update"
],
"updatedAt": "1505993096",
"updatedBy": "35",
"archived": "false",
"htmlContent": {
"type": "RawHtmlContent",
"contentSource": "upload"
}
},
{
"type": "Email",
"currentStatus": "Draft",
"id": "277",
"createdAt": "1603219095",
"createdBy": "35",
"depth": "minimal",
"folderId": "4197",
"name": "Event Invite #2",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update"
],
"updatedAt": "1603219104",
"updatedBy": "35",
"archived": "false",
"htmlContent": {
"type": "ResponsiveHtmlContent",
"contentSource": "responsive"
},
"subject": "You're Invited to a Webinar"
}
],
"page": 1,
"pageSize": 2,
"total": 175
}
Retrieve only archived emails:
GET /api/REST/2.0/assets/emails?includeArchived=true&includeAvailable=false
Response:
{
"elements": [
{
"type": "Email",
"currentStatus": "Draft",
"id": "8",
"createdAt": "1418671686",
"depth": "minimal",
"folderId": "4419",
"name": "test email",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update"
],
"updatedAt": "1420815547",
"archived": "true",
"htmlContent": {
"type": "StructuredHtmlContent",
"contentSource": "editor"
}
},
{
"type": "Email",
"currentStatus": "Draft",
"id": "30",
"createdAt": "1420751146",
"depth": "minimal",
"folderId": "4419",
"name": "testhtmlfile.html",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update"
],
"updatedAt": "1422045344",
"archived": "true",
"htmlContent": {
"type": "RawHtmlContent",
"contentSource": "upload"
},
"subject": "b"
}
],
"page": 1,
"pageSize": 1000,
"total": 2
}
Retrieve both archived and unarchived emails:
GET /api/REST/2.0/assets/emails?includeArchived=true
Response:
{
"elements": [
{
"type": "Email",
"currentStatus": "Draft",
"id": "1",
"createdAt": "1418403607",
"depth": "minimal",
"folderId": "3718",
"name": "September Buzz Email",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update"
],
"updatedAt": "1455061318",
"archived": "false",
"htmlContent": {
"type": "StructuredHtmlContent",
"contentSource": "editor"
},
"subject": "Test email"
},
{
"type": "Email",
"currentStatus": "Draft",
"id": "7",
"createdAt": "1418669386",
"depth": "minimal",
"folderId": "4195",
"name": "Email 2",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update"
],
"updatedAt": "1418669386",
"archived": "false",
"htmlContent": {
"type": "StructuredHtmlContent",
"contentSource": "editor"
},
"subject": "Test email"
}
...
],
"page": 1,
"pageSize": 1000,
"total": 177
}
cURL Examples
Here are the same examples in cURL given an instance with the name APITest
, username API.User
, and POD of 3
.
curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/rest/2.0/assets/emails?count=2
curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/rest/2.0/assets/emails?includeArchived=true&includeAvailable=false
curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/rest/2.0/assets/emails?includeArchived=true