Create a landing page
post
/api/REST/1.0/assets/landingPage
Creates a landing page that matches the criteria specified by the request body for
htmlContent
with a type of RawHtmlContent
.Request
Supported Media Types
- application/json
The request body defines the details of the landing page to be created.
Root Schema : LandingPage
Type:
object
Title:
Show Source
LandingPage
-
autoCloseWaitFor:
string
The amount of time the service will wait before closing.
-
autoRedirectUrl:
string
The landing page's auto re-direct URL.
-
autoRedirectWaitFor:
string
The amount of time the service will wait before redirecting to the auto re-direct URL.
-
contentSections:
array contentSections
A list of content sections contained within the landing page.
-
createdAt:
string
Read Only:
true
The date and time the landing page was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the landing page. -
currentStatus:
string
The landing page's current status. This is a read-only property.
-
deployedAt:
string
Unix timestamp for the date and time the landing page was deployed. 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 landing page.
-
dynamicContents:
array dynamicContents
A list of dynamic contents contained within the landing page.
-
files:
array files
A list of files contained within the landing page.
-
forms:
array forms
A list of forms contained within the landing page.
-
htmlContent:
object HtmlContent
Title:
HtmlContent
-
hyperlinks:
array hyperlinks
A list of hyperlinks contained within the landing page.
-
id:
string
Read Only:
true
Id of the landing page. This is a read-only property. -
images:
array images
A list of images contained within the landing page.
-
layout:
string
The landing page's main layout.
-
micrositeId:
string
Id of the associated microsite.
-
name:
string
The name of the landing page.
-
permissions:
string
The permissions for the landing page granted to your current instance. This is a read-only property.
-
refreshedAt:
string
Unix timestamp for the date and time the landing page was last refreshed. This is a read-only property.
-
relativePath:
string
The relative path of the landing page.
-
style:
string
The landing page'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 landing page was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the landing page.
Nested Schema : contentSections
Type:
array
A list of content sections contained within the landing page.
Show Source
-
Array of:
object ContentSection
Title:
ContentSection
Nested Schema : dynamicContents
Type:
array
A list of dynamic contents contained within the landing page.
Show Source
-
Array of:
object DynamicContent
Title:
DynamicContent
Nested Schema : files
Type:
array
A list of files contained within the landing page.
Show Source
-
Array of:
object ImportedFile
Title:
ImportedFile
Nested Schema : forms
Type:
array
A list of forms contained within the landing page.
Show Source
-
Array of:
object Form
Title:
Form
Nested Schema : hyperlinks
Type:
array
A list of hyperlinks contained within the landing page.
Show Source
-
Array of:
object Hyperlink
Title:
Hyperlink
Nested Schema : images
Type:
array
A list of images contained within the landing page.
Show Source
-
Array of:
object ImageFile
Title:
ImageFile
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. -
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.
-
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:
string
The permissions for the content section granted to your current instance. This is a read-only property.
-
scope:
string
The content sections's scope: either
local
orglobal
. -
size:
object Size
Title:
Size
-
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.
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 : 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. -
currentStatus:
string
The form's current status. Example: draft, active, or complete.
-
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.
-
emailAddressFormFieldId:
string
The email address form field entity's unique identifier.
-
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. This is a read-only property. -
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. -
name:
string
The name of the form.
-
permissions:
string
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.
-
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.
Nested Schema : elements
Type:
array
Array consisting of form elements.
Show Source
-
Array of:
object FormElement
Title:
FormElement
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 : 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. -
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.
-
id:
string
Read Only:
true
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:
string
The permissions for the form element granted to your current instance.
-
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.
Nested Schema : FormProcessingStep
Type:
object
Title:
Show Source
FormProcessingStep
-
conditionalComparator:
string
The comparator used to validate a condition. Possible values include:
exactly
ornot exactly
. -
conditionalFieldId:
string
The form field id used to compare form fields within a form processing step condition.
-
conditionalType:
string
The type of value the comparator is validating. Possible values include: 'form field' or 'static value'.
-
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. -
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
. -
id:
string
Read Only:
true
Id of the form processing step. This is a read-only property. -
isConditionallyNegated:
string
The conditions for which the processing step will execute. If
yes
, the processing step will execute when the conditions are met. Ifno
, the processing step will execute when the conditions are not met. -
name:
string
Name of the form processing step.
-
permissions:
string
The permissions for the form processing step granted to your current instance.
-
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.
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. -
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.
-
href:
string
Href value of the hyperlink.
-
hyperlinkType:
string
The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL.
-
id:
string
Read Only:
true
Id of the hyperlink. This is a read-only property. -
name:
string
Name of the hyperlink.
-
permissions:
string
The permissions for the hyperlink granted to your current instance.
-
referencedEntityId:
string
Id of the referenced entity.
-
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.
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. -
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.
-
fullImageUrl:
string
The image's complete URL. This is a read-only property.
-
id:
string
Read Only:
true
Id of the image. This is a read-only property. -
name:
string
The name of the image.
-
permissions:
string
The permissions for the image granted to your current instance. This is a read-only property.
-
size:
object Size
Title:
Size
-
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.
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. -
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.
-
id:
string
Read Only:
true
Id of the dynamic content. This is a read-only property. -
name:
string
Name of the dynamic content.
-
permissions:
string
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.
-
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. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the dynamic content. This is a read-only property.
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.
-
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. -
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.
-
id:
string
Read Only:
true
Id of the criterion. This is a read-only property. -
name:
string
Name of the criterion.
-
permissions:
string
The permissions for the criterion granted to your current instance.
-
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.
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. -
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.
-
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:
string
The permissions for the imported file granted to your current instance.
-
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. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the imported file. This is a read-only property.
Response
Supported Media Types
- application/json
201 Response
Success.
Root Schema : LandingPage
Type:
object
Title:
Show Source
LandingPage
-
autoCloseWaitFor:
string
The amount of time the service will wait before closing.
-
autoRedirectUrl:
string
The landing page's auto re-direct URL.
-
autoRedirectWaitFor:
string
The amount of time the service will wait before redirecting to the auto re-direct URL.
-
contentSections:
array contentSections
A list of content sections contained within the landing page.
-
createdAt:
string
Read Only:
true
The date and time the landing page was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the landing page. -
currentStatus:
string
The landing page's current status. This is a read-only property.
-
deployedAt:
string
Unix timestamp for the date and time the landing page was deployed. 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 landing page.
-
dynamicContents:
array dynamicContents
A list of dynamic contents contained within the landing page.
-
files:
array files
A list of files contained within the landing page.
-
forms:
array forms
A list of forms contained within the landing page.
-
htmlContent:
object HtmlContent
Title:
HtmlContent
-
hyperlinks:
array hyperlinks
A list of hyperlinks contained within the landing page.
-
id:
string
Read Only:
true
Id of the landing page. This is a read-only property. -
images:
array images
A list of images contained within the landing page.
-
layout:
string
The landing page's main layout.
-
micrositeId:
string
Id of the associated microsite.
-
name:
string
The name of the landing page.
-
permissions:
string
The permissions for the landing page granted to your current instance. This is a read-only property.
-
refreshedAt:
string
Unix timestamp for the date and time the landing page was last refreshed. This is a read-only property.
-
relativePath:
string
The relative path of the landing page.
-
style:
string
The landing page'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 landing page was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the landing page.
Nested Schema : contentSections
Type:
array
A list of content sections contained within the landing page.
Show Source
-
Array of:
object ContentSection
Title:
ContentSection
Nested Schema : dynamicContents
Type:
array
A list of dynamic contents contained within the landing page.
Show Source
-
Array of:
object DynamicContent
Title:
DynamicContent
Nested Schema : files
Type:
array
A list of files contained within the landing page.
Show Source
-
Array of:
object ImportedFile
Title:
ImportedFile
Nested Schema : forms
Type:
array
A list of forms contained within the landing page.
Show Source
-
Array of:
object Form
Title:
Form
Nested Schema : hyperlinks
Type:
array
A list of hyperlinks contained within the landing page.
Show Source
-
Array of:
object Hyperlink
Title:
Hyperlink
Nested Schema : images
Type:
array
A list of images contained within the landing page.
Show Source
-
Array of:
object ImageFile
Title:
ImageFile
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. -
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.
-
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:
string
The permissions for the content section granted to your current instance. This is a read-only property.
-
scope:
string
The content sections's scope: either
local
orglobal
. -
size:
object Size
Title:
Size
-
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.
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 : 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. -
currentStatus:
string
The form's current status. Example: draft, active, or complete.
-
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.
-
emailAddressFormFieldId:
string
The email address form field entity's unique identifier.
-
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. This is a read-only property. -
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. -
name:
string
The name of the form.
-
permissions:
string
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.
-
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.
Nested Schema : elements
Type:
array
Array consisting of form elements.
Show Source
-
Array of:
object FormElement
Title:
FormElement
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 : 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. -
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.
-
id:
string
Read Only:
true
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:
string
The permissions for the form element granted to your current instance.
-
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.
Nested Schema : FormProcessingStep
Type:
object
Title:
Show Source
FormProcessingStep
-
conditionalComparator:
string
The comparator used to validate a condition. Possible values include:
exactly
ornot exactly
. -
conditionalFieldId:
string
The form field id used to compare form fields within a form processing step condition.
-
conditionalType:
string
The type of value the comparator is validating. Possible values include: 'form field' or 'static value'.
-
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. -
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
. -
id:
string
Read Only:
true
Id of the form processing step. This is a read-only property. -
isConditionallyNegated:
string
The conditions for which the processing step will execute. If
yes
, the processing step will execute when the conditions are met. Ifno
, the processing step will execute when the conditions are not met. -
name:
string
Name of the form processing step.
-
permissions:
string
The permissions for the form processing step granted to your current instance.
-
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.
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. -
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.
-
href:
string
Href value of the hyperlink.
-
hyperlinkType:
string
The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL.
-
id:
string
Read Only:
true
Id of the hyperlink. This is a read-only property. -
name:
string
Name of the hyperlink.
-
permissions:
string
The permissions for the hyperlink granted to your current instance.
-
referencedEntityId:
string
Id of the referenced entity.
-
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.
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. -
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.
-
fullImageUrl:
string
The image's complete URL. This is a read-only property.
-
id:
string
Read Only:
true
Id of the image. This is a read-only property. -
name:
string
The name of the image.
-
permissions:
string
The permissions for the image granted to your current instance. This is a read-only property.
-
size:
object Size
Title:
Size
-
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.
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. -
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.
-
id:
string
Read Only:
true
Id of the dynamic content. This is a read-only property. -
name:
string
Name of the dynamic content.
-
permissions:
string
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.
-
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. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the dynamic content. This is a read-only property.
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.
-
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. -
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.
-
id:
string
Read Only:
true
Id of the criterion. This is a read-only property. -
name:
string
Name of the criterion.
-
permissions:
string
The permissions for the criterion granted to your current instance.
-
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.
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. -
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.
-
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:
string
The permissions for the imported file granted to your current instance.
-
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. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the imported file. This is a read-only property.
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
Create a new landing page:
POST /api/REST/1.0/assets/landingPage
Content-Type: application/json
Request body:
{
"name": "My Landing Page",
"htmlContent": {
"type": "RawHtmlContent",
"html": "<html><body><div>Here is some sample text.</div></body></html>",
"metaTags": []
}
}
Response:
{
"type": "LandingPage",
"x_e10_previewUrl": "https://<yourPod>.eloquapreview.com/Preview.aspx<yourId>",
"x_e10_previewExpiryDate": "1475865025",
"currentStatus": "Draft",
"id": "55",
"createdAt": "1475864725",
"createdBy": "9",
"depth": "complete",
"folderId": "1265",
"name": "My Landing Page",
"permissions": "fullControl",
"updatedAt": "1475864725",
"updatedBy": "9",
"contentSections": [
],
"deployedAt": "1475864725",
"dynamicContents": [
],
"htmlContent": {
"type": "RawHtmlContent",
"html": "<html><body><div>Here is some sample text.</div></body></html>"
},
"hyperlinks": [
],
"images": [
],
"layout": "",
"refreshedAt": "1475864725",
"style": ""
}