Jump to

• Request
• Response

Partially update a form

patch

/api/REST/2.0/assets/form/{id}

Partially updates the form specified by the id parameter. Only properties included in the request body will be modified.

Request

Supported Media Types

• application/json

Path Parameters

• id: integer
  Id of the form.

Body ()

The request body defines the details of the form for which properties are to be updated.

Root Schema : Form

Type: object

Title: Form

Show Source

• archived(optional): string
  True if form is archived otherwise False. This is a read-only property.
• createdAt(optional): string
  Read Only: true

  The date and time the form was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login ID of the user who created the form.
• currentStatus(optional): string
  The form's current status. Example: draft, active, or complete.
• customCSS(optional): string
  The custom style applied to the form.
• defaultKeyFieldMapping(optional): object FormFieldUpdateMapping
  Title: FormFieldUpdateMapping
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the form.
• elements(optional): array elements
  Array consisting of form elements.
• externalIntegrationUrl(optional): string
  The external integration URL used for integrating external forms.
• folderId(optional): string
  Read Only: true

  The ID of the containing folder.
• formJson(optional): 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(optional): string
  The asset's raw HTML content.
• htmlName(optional): string
  The asset's raw HTML name.
• id(optional): string
  Read Only: true

  Id of the form.
• isFormSpamProtectionEnabled(optional): string
  Indicates whether spam protection is enabled on the form.
• isHidden(optional): 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(optional): 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(optional): string
  The name of the form.
• permissions(optional): array permissions
  The permissions for the form granted to your current instance. This is a read-only property.
• processingSteps(optional): 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(optional): string
  A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.
• scheduledFor(optional): string
  Read Only: true

  This property is not used.
• size(optional): object Size
  Title: Size
• sourceTemplateId(optional): string
  Id of the source template.
• style(optional): string
  The asset's main layout style.
• submitFailedLandingPageId(optional): string
  The landing page ID of the failed submit.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form was last updated.
• updatedBy(optional): string
  Read Only: true

  The login ID of the user that last updated the form.

{
    "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."
        },
        "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":"array",
            "description":"The permissions for the form granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The ID of the containing folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login ID of the user who created the 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."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "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."
        },
        "submitFailedLandingPageId":{
            "type":"string",
            "description":"The landing page ID of the failed submit."
        },
        "size":{
            "$ref":"#/definitions/SizeRest20",
            "description":"The size dimensions of the form."
        },
        "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":"#/definitions/FormElementRest20"
            }
        },
        "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":"#/definitions/FormProcessingStepRest20"
            }
        },
        "defaultKeyFieldMapping":{
            "$ref":"#/definitions/FormFieldUpdateMappingRest20",
            "description":"The default key field mapping for the form."
        },
        "externalIntegrationUrl":{
            "type":"string",
            "description":"The external integration URL used for integrating external forms."
        },
        "customCSS":{
            "type":"string",
            "description":"The custom style applied to the form."
        },
        "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."
        },
        "formJson":{
            "type":"string",
            "description":"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 <code>{\\\"type\\\":\\\"responsiveForm\\\",\\\"version\\\":\\\"1\\\"}</code>."
        },
        "isResponsive":{
            "type":"string",
            "description":"Indicates whether the form is responsive. Returns <code>true</code> for a responsive form, <code>false</code> for a legacy form. Avoid sending this property when creating and updating forms. This is a read-only property."
        },
        "archived":{
            "type":"string",
            "description":"True if form is archived otherwise False. This is a read-only property."
        },
        "isFormSpamProtectionEnabled":{
            "type":"string",
            "description":"Indicates whether spam protection is enabled on the form."
        }
    }
}

Nested Schema : FormFieldUpdateMapping

Type: object

Title: FormFieldUpdateMapping

Show Source

• createdAt(optional): string
  Read Only: true

  The date and time the form field update mapping was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the form field update mapping.
• currentStatus(optional): string
  The form field update mapping's current status.
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the field comparison criteria.
• folderId(optional): string
  Read Only: true

  Id of the folder. This is a read-only property.
• id(optional): string
  Read Only: true

  Id of the form field update mapping.
• name(optional): string
  The name of the form field update mapping.
• permissions(optional): array permissions
  The permissions for the form field update mapping granted to your current instance. This is a read-only property.
• scheduledFor(optional): string
  Read Only: true

  The date and time the form field update mapping is scheduled.
• sourceFormFieldId(optional): string
  Id of the source form field.
• sourceTemplateId(optional): string
  Id of the source template. This is a read-only property.
• targetEntityFieldId(optional): string
  Id of the target field.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form field update mapping was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the form field update mapping.
• updateType(optional): string
  The update type of the form field update mapping.

{
    "title":"FormFieldUpdateMapping",
    "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 field update mapping."
        },
        "currentStatus":{
            "type":"string",
            "description":"The form field update mapping's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the form field update mapping."
        },
        "description":{
            "type":"string",
            "description":"The description of the field comparison criteria."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the form field update mapping granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the folder. This is a read-only property."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the source template. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the form field update mapping."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the form field update mapping was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the form field update mapping."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the form field update mapping was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the form field update mapping is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "sourceFormFieldId":{
            "type":"string",
            "description":"Id of the source form field. "
        },
        "updateType":{
            "type":"string",
            "description":"The update type of the form field update mapping."
        },
        "targetEntityFieldId":{
            "type":"string",
            "description":"Id of the target field."
        }
    }
}

Nested Schema : elements

Type: array

Array consisting of form elements.

Show Source

• Array of: object FormElement
  Title: FormElement

{
    "type":"array",
    "description":"Array consisting of form elements.",
    "items":{
        "$ref":"#/definitions/FormElementRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the form granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the form granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

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

{
    "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":"#/definitions/FormProcessingStepRest20"
    }
}

Nested Schema : Size

Type: object

Title: Size

Show Source

• height(optional): string
  The height dimensions of the asset expressed in pixels.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'.
• width(optional): string
  The width dimensions of the asset expressed in pixels.

{
    "title":"Size",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'."
        },
        "width":{
            "type":"string",
            "description":"The width dimensions of the asset expressed in pixels."
        },
        "height":{
            "type":"string",
            "description":"The height dimensions of the asset expressed in pixels."
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"The permissions for the form field update mapping granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : FormElement

Type: object

Title: FormElement

Show Source

• createdAt(optional): string
  Read Only: true

  The date and time the form element was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login ID of the user who created the form element.
• currentStatus(optional): string
  The form element's current status.
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the form element.
• folderId(optional): string
  Read Only: true

  The ID of the associated folder.
• id(optional): string
  Read Only: true

  The ID of the form element. This is a read-only property.
• instructions(optional): string
  The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
• name(optional): string
  Name of the form element.
• permissions(optional): array permissions
  The permissions for the form element granted to your current instance.
• scheduledFor(optional): string
  Read Only: true

  The date the form element is scheduled.
• sourceTemplateId(optional): string
  The ID of the form element.
• style(optional): string
  The asset's main layout style.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form element was last updated.
• updatedBy(optional): string
  Read Only: true

  The login ID of the user that last updated the form element.

{
    "title":"FormElement",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The ID of the form element. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The form element's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the form element."
        },
        "description":{
            "type":"string",
            "description":"The description of the form element."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the form element granted to your current instance.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The ID of the associated folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"The ID of the form element."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login ID of the user who created the form element."
        },
        "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."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the form element is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth' target='_blank'>Request depth</a>."
        },
        "instructions":{
            "type":"string",
            "description":"The form element's field instructions. Field instructions are optional instructions that help users fill in fields."
        },
        "style":{
            "type":"string",
            "description":"The asset's main layout style."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the form element granted to your current instance.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the form element granted to your current instance.",
    "items":{
        "type":"string"
    }
}

Nested Schema : FormProcessingStep

Type: object

Title: FormProcessingStep

Show Source

• condition(optional): object ProcessingStepCondition
  Title: ProcessingStepCondition
• createdAt(optional): string
  Read Only: true

  The date and time the form processing step was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login ID of the user who created the form processing step.
• currentStatus(optional): string
  The form processing step's current status.
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the form processing step.
• execute(optional): string
  The conditions for which this form processing step will execute. Possible values include: always, conditionally, and never.
• folderId(optional): string
  Read Only: true

  Id of the associated folder.
• hasValidationIssue(optional): string
  ProcessingStep_Field_HasValidationIssue_Description
• id(optional): string
  Read Only: true

  Id of the form processing step. This is a read-only property.
• name(optional): string
  Name of the form processing step.
• permissions(optional): array permissions
  The permissions for the form processing step granted to your current instance.
• scheduledFor(optional): string
  Read Only: true

  The date the form processing step is scheduled.
• sourceTemplateId(optional): string
  The ID of the source template.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form processing step was last updated.
• updatedBy(optional): string
  Read Only: true

  The login ID of the user that last updated the form processing step.

{
    "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."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the form processing step granted to your current instance.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the associated folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"The ID of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login ID of the user who created the 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."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the form processing step is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "execute":{
            "type":"string",
            "description":"The conditions for which this form processing step will execute. Possible values include: <code>always</code>, <code>conditionally</code>, and <code>never</code>."
        },
        "condition":{
            "$ref":"#/definitions/ProcessingStepConditionRest20",
            "description":"ProcessingStep_Field_ProcessingStepCondition_Description"
        },
        "description":{
            "type":"string",
            "description":"The description of the form processing step."
        },
        "hasValidationIssue":{
            "type":"string",
            "description":"ProcessingStep_Field_HasValidationIssue_Description"
        }
    }
}

Nested Schema : ProcessingStepCondition

Type: object

Title: ProcessingStepCondition

Show Source

• conditionalFieldCriteria(optional): array conditionalFieldCriteria
  The conditional field criteria for the form processing step condition.
• isConditionallyNegated(optional): 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(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"ProcessingStepCondition",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "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."
        },
        "conditionalFieldCriteria":{
            "type":"array",
            "description":"The conditional field criteria for the form processing step condition.",
            "items":{
                "$ref":"#/definitions/FieldComparisonCriteriaRest20"
            }
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the form processing step granted to your current instance.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the form processing step granted to your current instance.",
    "items":{
        "type":"string"
    }
}

Nested Schema : conditionalFieldCriteria

Type: array

The conditional field criteria for the form processing step condition.

Show Source

• Array of: object FieldComparisonCriteria
  Title: FieldComparisonCriteria

{
    "type":"array",
    "description":"The conditional field criteria for the form processing step condition.",
    "items":{
        "$ref":"#/definitions/FieldComparisonCriteriaRest20"
    }
}

Nested Schema : FieldComparisonCriteria

Type: object

Title: FieldComparisonCriteria

Show Source

• condition(optional): object Condition
  Title: Condition
• createdAt(optional): string
  Read Only: true

  The date and time the field comparison criteria was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the field comparison criteria.
• currentStatus(optional): string
  The field comparison criteria's current status.
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the field comparison criteria.
• fieldId(optional): string
  The id of the field comparison criteria.
• folderId(optional): string
  Read Only: true

  Id of the folder. This is a read-only property.
• id(optional): string
  Read Only: true

  Id of the field comparison criteria.
• name(optional): string
  The name of the field comparison criteria.
• permissions(optional): array permissions
  The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
• scheduledFor(optional): string
  Read Only: true

  The date and time the field comparison criteria is scheduled.
• sourceTemplateId(optional): string
  Id of the source template. This is a read-only property.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the field comparison criteria was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the field comparison criteria.

{
    "title":"FieldComparisonCriteria",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the field comparison criteria."
        },
        "currentStatus":{
            "type":"string",
            "description":"The field comparison criteria's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the field comparison criteria."
        },
        "description":{
            "type":"string",
            "description":"The description of the field comparison criteria."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the field comparison criteria granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the folder. This is a read-only property."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the source template. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the field comparison criteria."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the field comparison criteria was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the field comparison criteria."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the field comparison criteria was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the field comparison criteria is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "fieldId":{
            "type":"string",
            "description":"The id of the field comparison criteria."
        },
        "condition":{
            "$ref":"#/definitions/ConditionRest20",
            "description":"The condition of the field comparison criteria."
        }
    }
}

Nested Schema : Condition

Type: object

Title: Condition

Show Source

• type(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"Condition",
    "properties":{
        "type":{
            "type":"string",
            "description":"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

• Array of: string

{
    "type":"array",
    "description":"The permissions for the field comparison criteria granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : Form

Type: object

Title: Form

Show Source

• archived(optional): string
  True if form is archived otherwise False. This is a read-only property.
• createdAt(optional): string
  Read Only: true

  The date and time the form was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login ID of the user who created the form.
• currentStatus(optional): string
  The form's current status. Example: draft, active, or complete.
• customCSS(optional): string
  The custom style applied to the form.
• defaultKeyFieldMapping(optional): object FormFieldUpdateMapping
  Title: FormFieldUpdateMapping
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the form.
• elements(optional): array elements
  Array consisting of form elements.
• externalIntegrationUrl(optional): string
  The external integration URL used for integrating external forms.
• folderId(optional): string
  Read Only: true

  The ID of the containing folder.
• formJson(optional): 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(optional): string
  The asset's raw HTML content.
• htmlName(optional): string
  The asset's raw HTML name.
• id(optional): string
  Read Only: true

  Id of the form.
• isFormSpamProtectionEnabled(optional): string
  Indicates whether spam protection is enabled on the form.
• isHidden(optional): 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(optional): 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(optional): string
  The name of the form.
• permissions(optional): array permissions
  The permissions for the form granted to your current instance. This is a read-only property.
• processingSteps(optional): 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(optional): string
  A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.
• scheduledFor(optional): string
  Read Only: true

  This property is not used.
• size(optional): object Size
  Title: Size
• sourceTemplateId(optional): string
  Id of the source template.
• style(optional): string
  The asset's main layout style.
• submitFailedLandingPageId(optional): string
  The landing page ID of the failed submit.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form was last updated.
• updatedBy(optional): string
  Read Only: true

  The login ID of the user that last updated the form.

{
    "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."
        },
        "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":"array",
            "description":"The permissions for the form granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The ID of the containing folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login ID of the user who created the 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."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "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."
        },
        "submitFailedLandingPageId":{
            "type":"string",
            "description":"The landing page ID of the failed submit."
        },
        "size":{
            "$ref":"#/definitions/SizeRest20",
            "description":"The size dimensions of the form."
        },
        "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":"#/definitions/FormElementRest20"
            }
        },
        "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":"#/definitions/FormProcessingStepRest20"
            }
        },
        "defaultKeyFieldMapping":{
            "$ref":"#/definitions/FormFieldUpdateMappingRest20",
            "description":"The default key field mapping for the form."
        },
        "externalIntegrationUrl":{
            "type":"string",
            "description":"The external integration URL used for integrating external forms."
        },
        "customCSS":{
            "type":"string",
            "description":"The custom style applied to the form."
        },
        "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."
        },
        "formJson":{
            "type":"string",
            "description":"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 <code>{\\\"type\\\":\\\"responsiveForm\\\",\\\"version\\\":\\\"1\\\"}</code>."
        },
        "isResponsive":{
            "type":"string",
            "description":"Indicates whether the form is responsive. Returns <code>true</code> for a responsive form, <code>false</code> for a legacy form. Avoid sending this property when creating and updating forms. This is a read-only property."
        },
        "archived":{
            "type":"string",
            "description":"True if form is archived otherwise False. This is a read-only property."
        },
        "isFormSpamProtectionEnabled":{
            "type":"string",
            "description":"Indicates whether spam protection is enabled on the form."
        }
    }
}

Nested Schema : FormFieldUpdateMapping

Type: object

Title: FormFieldUpdateMapping

Show Source

• createdAt(optional): string
  Read Only: true

  The date and time the form field update mapping was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the form field update mapping.
• currentStatus(optional): string
  The form field update mapping's current status.
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the field comparison criteria.
• folderId(optional): string
  Read Only: true

  Id of the folder. This is a read-only property.
• id(optional): string
  Read Only: true

  Id of the form field update mapping.
• name(optional): string
  The name of the form field update mapping.
• permissions(optional): array permissions
  The permissions for the form field update mapping granted to your current instance. This is a read-only property.
• scheduledFor(optional): string
  Read Only: true

  The date and time the form field update mapping is scheduled.
• sourceFormFieldId(optional): string
  Id of the source form field.
• sourceTemplateId(optional): string
  Id of the source template. This is a read-only property.
• targetEntityFieldId(optional): string
  Id of the target field.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form field update mapping was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the form field update mapping.
• updateType(optional): string
  The update type of the form field update mapping.

{
    "title":"FormFieldUpdateMapping",
    "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 field update mapping."
        },
        "currentStatus":{
            "type":"string",
            "description":"The form field update mapping's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the form field update mapping."
        },
        "description":{
            "type":"string",
            "description":"The description of the field comparison criteria."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the form field update mapping granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the folder. This is a read-only property."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the source template. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the form field update mapping."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the form field update mapping was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the form field update mapping."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the form field update mapping was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the form field update mapping is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "sourceFormFieldId":{
            "type":"string",
            "description":"Id of the source form field. "
        },
        "updateType":{
            "type":"string",
            "description":"The update type of the form field update mapping."
        },
        "targetEntityFieldId":{
            "type":"string",
            "description":"Id of the target field."
        }
    }
}

Nested Schema : elements

Type: array

Array consisting of form elements.

Show Source

• Array of: object FormElement
  Title: FormElement

{
    "type":"array",
    "description":"Array consisting of form elements.",
    "items":{
        "$ref":"#/definitions/FormElementRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the form granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the form granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

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

{
    "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":"#/definitions/FormProcessingStepRest20"
    }
}

Nested Schema : Size

Type: object

Title: Size

Show Source

• height(optional): string
  The height dimensions of the asset expressed in pixels.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'.
• width(optional): string
  The width dimensions of the asset expressed in pixels.

{
    "title":"Size",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'."
        },
        "width":{
            "type":"string",
            "description":"The width dimensions of the asset expressed in pixels."
        },
        "height":{
            "type":"string",
            "description":"The height dimensions of the asset expressed in pixels."
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"The permissions for the form field update mapping granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : FormElement

Type: object

Title: FormElement

Show Source

• createdAt(optional): string
  Read Only: true

  The date and time the form element was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login ID of the user who created the form element.
• currentStatus(optional): string
  The form element's current status.
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the form element.
• folderId(optional): string
  Read Only: true

  The ID of the associated folder.
• id(optional): string
  Read Only: true

  The ID of the form element. This is a read-only property.
• instructions(optional): string
  The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
• name(optional): string
  Name of the form element.
• permissions(optional): array permissions
  The permissions for the form element granted to your current instance.
• scheduledFor(optional): string
  Read Only: true

  The date the form element is scheduled.
• sourceTemplateId(optional): string
  The ID of the form element.
• style(optional): string
  The asset's main layout style.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form element was last updated.
• updatedBy(optional): string
  Read Only: true

  The login ID of the user that last updated the form element.

{
    "title":"FormElement",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The ID of the form element. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The form element's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the form element."
        },
        "description":{
            "type":"string",
            "description":"The description of the form element."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the form element granted to your current instance.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The ID of the associated folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"The ID of the form element."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login ID of the user who created the form element."
        },
        "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."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the form element is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth' target='_blank'>Request depth</a>."
        },
        "instructions":{
            "type":"string",
            "description":"The form element's field instructions. Field instructions are optional instructions that help users fill in fields."
        },
        "style":{
            "type":"string",
            "description":"The asset's main layout style."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the form element granted to your current instance.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the form element granted to your current instance.",
    "items":{
        "type":"string"
    }
}

Nested Schema : FormProcessingStep

Type: object

Title: FormProcessingStep

Show Source

• condition(optional): object ProcessingStepCondition
  Title: ProcessingStepCondition
• createdAt(optional): string
  Read Only: true

  The date and time the form processing step was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login ID of the user who created the form processing step.
• currentStatus(optional): string
  The form processing step's current status.
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the form processing step.
• execute(optional): string
  The conditions for which this form processing step will execute. Possible values include: always, conditionally, and never.
• folderId(optional): string
  Read Only: true

  Id of the associated folder.
• hasValidationIssue(optional): string
  ProcessingStep_Field_HasValidationIssue_Description
• id(optional): string
  Read Only: true

  Id of the form processing step. This is a read-only property.
• name(optional): string
  Name of the form processing step.
• permissions(optional): array permissions
  The permissions for the form processing step granted to your current instance.
• scheduledFor(optional): string
  Read Only: true

  The date the form processing step is scheduled.
• sourceTemplateId(optional): string
  The ID of the source template.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the form processing step was last updated.
• updatedBy(optional): string
  Read Only: true

  The login ID of the user that last updated the form processing step.

{
    "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."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the form processing step granted to your current instance.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the associated folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"The ID of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login ID of the user who created the 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."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the form processing step is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "execute":{
            "type":"string",
            "description":"The conditions for which this form processing step will execute. Possible values include: <code>always</code>, <code>conditionally</code>, and <code>never</code>."
        },
        "condition":{
            "$ref":"#/definitions/ProcessingStepConditionRest20",
            "description":"ProcessingStep_Field_ProcessingStepCondition_Description"
        },
        "description":{
            "type":"string",
            "description":"The description of the form processing step."
        },
        "hasValidationIssue":{
            "type":"string",
            "description":"ProcessingStep_Field_HasValidationIssue_Description"
        }
    }
}

Nested Schema : ProcessingStepCondition

Type: object

Title: ProcessingStepCondition

Show Source

• conditionalFieldCriteria(optional): array conditionalFieldCriteria
  The conditional field criteria for the form processing step condition.
• isConditionallyNegated(optional): 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(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"ProcessingStepCondition",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "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."
        },
        "conditionalFieldCriteria":{
            "type":"array",
            "description":"The conditional field criteria for the form processing step condition.",
            "items":{
                "$ref":"#/definitions/FieldComparisonCriteriaRest20"
            }
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the form processing step granted to your current instance.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the form processing step granted to your current instance.",
    "items":{
        "type":"string"
    }
}

Nested Schema : conditionalFieldCriteria

Type: array

The conditional field criteria for the form processing step condition.

Show Source

• Array of: object FieldComparisonCriteria
  Title: FieldComparisonCriteria

{
    "type":"array",
    "description":"The conditional field criteria for the form processing step condition.",
    "items":{
        "$ref":"#/definitions/FieldComparisonCriteriaRest20"
    }
}

Nested Schema : FieldComparisonCriteria

Type: object

Title: FieldComparisonCriteria

Show Source

• condition(optional): object Condition
  Title: Condition
• createdAt(optional): string
  Read Only: true

  The date and time the field comparison criteria was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the field comparison criteria.
• currentStatus(optional): string
  The field comparison criteria's current status.
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the field comparison criteria.
• fieldId(optional): string
  The id of the field comparison criteria.
• folderId(optional): string
  Read Only: true

  Id of the folder. This is a read-only property.
• id(optional): string
  Read Only: true

  Id of the field comparison criteria.
• name(optional): string
  The name of the field comparison criteria.
• permissions(optional): array permissions
  The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
• scheduledFor(optional): string
  Read Only: true

  The date and time the field comparison criteria is scheduled.
• sourceTemplateId(optional): string
  Id of the source template. This is a read-only property.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the field comparison criteria was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the field comparison criteria.

{
    "title":"FieldComparisonCriteria",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the field comparison criteria."
        },
        "currentStatus":{
            "type":"string",
            "description":"The field comparison criteria's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the field comparison criteria."
        },
        "description":{
            "type":"string",
            "description":"The description of the field comparison criteria."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the field comparison criteria granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the folder. This is a read-only property."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the source template. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the field comparison criteria."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the field comparison criteria was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the field comparison criteria."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the field comparison criteria was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the field comparison criteria is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "fieldId":{
            "type":"string",
            "description":"The id of the field comparison criteria."
        },
        "condition":{
            "$ref":"#/definitions/ConditionRest20",
            "description":"The condition of the field comparison criteria."
        }
    }
}

Nested Schema : Condition

Type: object

Title: Condition

Show Source

• type(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"Condition",
    "properties":{
        "type":{
            "type":"string",
            "description":"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

• Array of: string

{
    "type":"array",
    "description":"The permissions for the field comparison criteria granted to your current instance. This is a read-only property.",
    "items":{
        "type":"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.

Back to Top