openapi: 3.2.0
info:
title: REST API for Oracle Eloqua Marketing Cloud Service Application/1.0/Landing pages 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/1.0/Landing pages
description: "Landing pages are often the first significant part of a campaign that a contact will see. A contact may be directed to your landing page from a link in an email or from an ad on the web. The landing page provides the contact with more information and options related to the email or ad that brought them there. On the landing page they can be asked to participate in the campaign by reviewing detailed information, submitting a form, or clicking a button to receive additional information etc. The landing page moves prospects through your campaign and gives them a clearer idea about your product and your companies trustworthiness. \n\nLearn more about landing pages."
paths:
/api/rest/1.0/assets/landingPage:
post:
operationId: CreateIndividualPOSTRest10
summary: Create a landing page
description: Creates a landing page that matches the criteria specified by the request body for htmlContent with a type of RawHtmlContent.
responses:
'201':
description: Success.
content:
application/json:
schema:
$ref: '#/components/schemas/LandingPageRest10'
'400':
description: Bad request. See Status Codes for information about other possible HTTP status codes.
'401':
description: Unauthorized. See Status Codes for information about other possible HTTP status codes.
'403':
description: Forbidden. See Status Codes for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
'500':
description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
tags:
- Application/1.0/Landing pages
x-internal-id: api-rest-1.0-assets-landingPage-post
x-filename-id: api-rest-1.0-assets-landingpage-post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LandingPageRest10'
description: The request body defines the details of the landing page to be created.
required: true
/api/rest/1.0/assets/landingPage/{id}:
get:
operationId: ReadIndividualGETRest10
parameters:
- name: id
in: path
description: Id of the landing page to retrieve.
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: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
required: false
schema:
type: string
summary: Retrieve a landing page
description: Retrieves the landing page specified by the id parameter.
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/LandingPageRest10'
'400':
description: Bad request. See Status Codes for information about other possible HTTP status codes.
'401':
description: Unauthorized. See Status Codes for information about other possible HTTP status codes.
'403':
description: Forbidden. See Status Codes for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
'500':
description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
tags:
- Application/1.0/Landing pages
x-internal-id: api-rest-1.0-assets-landingPage-{id}-get
x-filename-id: api-rest-1.0-assets-landingpage-id-get
put:
operationId: UpdateIndividualPUTRest10
parameters:
- name: id
in: path
description: Id of the landing page to update.
required: true
schema:
type: integer
summary: Update a landing page
description: Updates the landing page specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/LandingPageRest10'
'400':
description: Bad request. See Status Codes for information about other possible HTTP status codes.
'401':
description: Unauthorized. See Status Codes for information about other possible HTTP status codes.
'403':
description: Forbidden. See Status Codes for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
'500':
description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
tags:
- Application/1.0/Landing pages
x-internal-id: api-rest-1.0-assets-landingPage-{id}-put
x-filename-id: api-rest-1.0-assets-landingpage-id-put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LandingPageRest10'
description: The request body defines the details of the landing page to be updated.
required: true
delete:
operationId: DeleteIndividualDELETERest10
parameters:
- name: id
in: path
description: Id of the landing page to delete.
required: true
schema:
type: integer
summary: Delete a landing page
description: Deletes the landing page specified by the id parameter.
responses:
'200':
description: OK.
'400':
description: Bad request. See Status Codes for information about other possible HTTP status codes.
'401':
description: Unauthorized. See Status Codes for information about other possible HTTP status codes.
'403':
description: Forbidden. See Status Codes for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
'500':
description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
tags:
- Application/1.0/Landing pages
x-internal-id: api-rest-1.0-assets-landingPage-{id}-delete
x-filename-id: api-rest-1.0-assets-landingpage-id-delete
/api/rest/1.0/assets/landingPages:
get:
operationId: SearchGETRest10
parameters:
- name: depth
in: query
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.'
required: false
schema:
type: string
- name: count
in: query
description: Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
required: false
schema:
type: integer
- name: page
in: query
description: 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.
required: false
schema:
type: integer
- name: search
in: query
description: Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
required: false
schema:
type: string
- name: orderBy
in: query
description: Specifies the field by which list results are ordered.
required: false
schema:
type: string
- name: lastUpdatedAt
in: query
description: Unix timestamp for the date and time the external asset was last updated.
required: false
schema:
type: integer
summary: Retrieve a list of landing pages
description: Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResultLandingPageRest10'
'400':
description: Bad request. See Status Codes for information about other possible HTTP status codes.
'401':
description: Unauthorized. See Status Codes for information about other possible HTTP status codes.
'403':
description: Forbidden. See Status Codes for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
'500':
description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
tags:
- Application/1.0/Landing pages
x-internal-id: api-rest-1.0-assets-landingPages-get
x-filename-id: api-rest-1.0-assets-landingpages-get
components:
schemas:
DynamicContentRuleRest10:
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: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
contentSection:
$ref: '#/components/schemas/ContentSectionRest10'
description: A list of associated Content Section assets.
criteria:
type: array
description: The criteria of the dynamic content rule.
items:
$ref: '#/components/schemas/CriterionRest10'
statement:
type: string
description: The statement of the dynamic content rule.
FormProcessingStepRest10:
title: FormProcessingStep
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 form processing step. This is a read-only property.
currentStatus:
type: string
description: The form processing step's current status.
name:
type: string
description: Name of the form processing step.
description:
type: string
description: The description of the form processing step.
permissions:
type: string
description: The permissions for the form processing step granted to your current instance.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the form processing step.
createdAt:
type: string
readOnly: true
description: The date and time the form processing step was created, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the form processing step.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the form processing step was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
execute:
type: string
description: 'The conditions for which this form processing step will execute. Possible values include: always, conditionally, and never.'
conditionalType:
type: string
description: 'The type of value the comparator is validating. Possible values include: ''form field'' or ''static value''.'
conditionalFieldId:
type: string
description: The form field id used to compare form fields within a form processing step condition.
conditionalComparator:
type: string
description: 'The comparator used to validate a condition. Possible values include: exactly or not exactly.'
isConditionallyNegated:
type: string
description: 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.
HyperlinkRest10:
title: Hyperlink
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 hyperlink. This is a read-only property.
currentStatus:
type: string
description: The hyperlink's current status.
name:
type: string
description: Name of the hyperlink.
description:
type: string
description: The description of the hyperlink.
permissions:
type: string
description: The permissions for the hyperlink granted to your current instance.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the hyperlink.
createdAt:
type: string
readOnly: true
description: The date and time the hyperlink was created, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the hyperlink.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the hyperlink was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
href:
type: string
description: Href value of the hyperlink.
hyperlinkType:
type: string
description: 'The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL.'
referencedEntityId:
type: string
description: Id of the referenced entity.
SizeRest10:
title: Size
properties:
type:
type: string
CriterionRest10:
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: string
description: The permissions for the criterion granted to your current instance.
createdBy:
type: string
readOnly: true
description: The login id 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.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the criterion was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
HtmlContentRest10:
title: HtmlContent
properties:
type:
type: string
ContentSectionRest10:
title: ContentSection
properties:
type:
type: string
description: The content section's type in Eloqua. This is a read-only property.
id:
type: string
readOnly: true
description: Id of the content section. This is a read-only property.
currentStatus:
type: string
description: The content section's current status. This is a read-only property.
name:
type: string
description: The name of the content section.
description:
type: string
description: The description of the content section.
permissions:
type: string
description: The permissions for the content section granted to your current instance. This is a read-only property.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the content section.
createdAt:
type: string
readOnly: true
description: The date and time the content section was created, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the content section.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the content section was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
contentHtml:
type: string
description: The content section's HTML content.
contentText:
type: string
description: The content section's text content.
scope:
type: string
description: 'The content sections''s scope: either local or global.'
forms:
type: array
description: A list of associated Form assets.
items:
$ref: '#/components/schemas/FormRest10'
images:
type: array
description: A list of associated Image assets.
items:
$ref: '#/components/schemas/ImageFileRest10'
hyperlinks:
type: array
description: A list of hyperlinks contained within the content section.
items:
$ref: '#/components/schemas/HyperlinkRest10'
size:
$ref: '#/components/schemas/SizeRest10'
description: 'Generally contains 3 fields: type, width and height. "type" should be set to "Size", and width and height can be set to the content section''s desired dimensions.'
ImageFileRest10:
title: ImageFile
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 image. This is a read-only property.
currentStatus:
type: string
description: The image's current status.
name:
type: string
description: The name of the image.
description:
type: string
description: The description of the image.
permissions:
type: string
description: The permissions for the image granted to your current instance. This is a read-only property.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the image.
createdAt:
type: string
readOnly: true
description: The date and time the image was created, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the image.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the image was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
fullImageUrl:
type: string
description: The image's complete URL. This is a read-only property.
size:
$ref: '#/components/schemas/SizeRest10'
description: 'The size of the image. Contains 3 fields: type, width and height. "type" should be set to "Size", and width and height can be set to the image''s desired dimensions.'
thumbnailUrl:
type: string
description: The image's thumbnail URL. This is a read-only property.
DynamicContentRest10:
title: DynamicContent
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 dynamic content. This is a read-only property.
currentStatus:
type: string
description: The dynamic content's current status.
name:
type: string
description: Name of the dynamic content.
description:
type: string
description: The description of the dynamic content.
permissions:
type: string
description: The permissions for the dynamic content granted to your current instance. This is a read-only property.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the dynamic content.
createdAt:
type: string
readOnly: true
description: The date and time the dynamic content was last accessed, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the dynamic content. This is a read-only property.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the dynamic content was last updated. This is a read-only property.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
defaultContentSection:
$ref: '#/components/schemas/ContentSectionRest10'
description: The default content section of the dynamic content.
rules:
type: array
description: The dynamic content's rules.
items:
$ref: '#/components/schemas/DynamicContentRuleRest10'
FormRest10:
title: Form
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 form. This is a read-only property.
currentStatus:
type: string
description: 'The form''s current status. Example: draft, active, or complete.'
name:
type: string
description: The name of the form.
description:
type: string
description: The description of the form.
permissions:
type: string
description: The permissions for the form granted to your current instance. This is a read-only property.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the form.
createdAt:
type: string
readOnly: true
description: The date and time the form was created, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the form.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the form was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
htmlName:
type: string
description: The asset's raw HTML name.
processingType:
type: string
description: 'A list of the form''s processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.'
emailAddressFormFieldId:
type: string
description: The email address form field entity's unique identifier.
submitFailedLandingPageId:
type: string
description: The landing page id of the failed submit.
html:
type: string
description: The asset's raw HTML content.
style:
type: string
description: The asset's main layout style.
elements:
type: array
description: Array consisting of form elements.
items:
$ref: '#/components/schemas/FormElementRest10'
processingSteps:
type: array
description: '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.'
items:
$ref: '#/components/schemas/FormProcessingStepRest10'
isHidden:
type: string
description: 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.
archived:
type: string
description: True if form is archived otherwise False. This is a read-only property.
LandingPageRest10:
title: LandingPage
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 landing page. This is a read-only property.
currentStatus:
type: string
description: The landing page's current status. This is a read-only property.
name:
type: string
description: The name of the landing page.
description:
type: string
description: The description of the landing page.
permissions:
type: string
description: The permissions for the landing page granted to your current instance. This is a read-only property.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the landing page.
createdAt:
type: string
readOnly: true
description: The date and time the landing page was created, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the landing page.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the landing page was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
deployedAt:
type: string
description: Unix timestamp for the date and time the landing page was deployed. This is a read-only property.
micrositeId:
type: string
description: Id of the associated microsite.
refreshedAt:
type: string
description: Unix timestamp for the date and time the landing page was last refreshed. This is a read-only property.
htmlContent:
$ref: '#/components/schemas/HtmlContentRest10'
description: The landing page's raw html content.
layout:
type: string
description: The landing page's main layout.
style:
type: string
description: The landing page's main layout style.
forms:
type: array
description: A list of forms contained within the landing page.
items:
$ref: '#/components/schemas/FormRest10'
images:
type: array
description: A list of images contained within the landing page.
items:
$ref: '#/components/schemas/ImageFileRest10'
hyperlinks:
type: array
description: A list of hyperlinks contained within the landing page.
items:
$ref: '#/components/schemas/HyperlinkRest10'
contentSections:
type: array
description: A list of content sections contained within the landing page.
items:
$ref: '#/components/schemas/ContentSectionRest10'
dynamicContents:
type: array
description: A list of dynamic contents contained within the landing page.
items:
$ref: '#/components/schemas/DynamicContentRest10'
files:
type: array
description: A list of files contained within the landing page.
items:
$ref: '#/components/schemas/ImportedFileRest10'
autoRedirectUrl:
type: string
description: The landing page's auto re-direct URL.
autoRedirectWaitFor:
type: string
description: The amount of time the service will wait before redirecting to the auto re-direct URL.
autoCloseWaitFor:
type: string
description: The amount of time the service will wait before closing.
relativePath:
type: string
description: The relative path of the landing page.
FormElementRest10:
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: 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: string
description: The permissions for the form element granted to your current instance.
createdBy:
type: string
readOnly: true
description: The login id 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.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the form element was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
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.
QueryResultLandingPageRest10:
title: QueryResultLandingPage
properties:
type:
type: string
description: The asset's type in Eloqua.
elements:
type: array
description: Array of landing page fields.
items:
$ref: '#/components/schemas/LandingPageRest10'
total:
type: integer
description: The total amount of results.
pageSize:
type: integer
description: The page size.
page:
type: integer
description: The specified page.
ImportedFileRest10:
title: ImportedFile
properties:
type:
type: string
description: The date and time the imported file was last accessed. This is a read-only property.
id:
type: string
readOnly: true
description: Id of the imported file. This is a read-only property.
currentStatus:
type: string
description: The imported file's current status.
name:
type: string
description: Name of the imported file.
description:
type: string
description: The description of the imported file.
permissions:
type: string
description: The permissions for the imported file granted to your current instance.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the imported file.
createdAt:
type: string
readOnly: true
description: The date and time the imported file was last accessed, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the imported file. This is a read-only property.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the imported file was last updated. This is a read-only property.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.'
fileName:
type: string
description: The file name of the imported file.
link:
type: string
description: The imported file's complete URL. This is a read-only property.
trackedLink:
type: string
description: The imported file's tracked complete URL. This is a read-only property.
brandId:
type: string
description: ImportedFile_Field_BrandId_Description