• actualCost(optional): string
  The campaign's actual cost.
• adCampaignId(optional): string
  Campaign_Field_AdCampaignId_Description
• badgeId(optional): string
  The badge id of the campaign.
• budgetedCost(optional): string
  The campaign's projected cost.
• campaignCategory(optional): string
  Defines whether a Campaign is simple or multi-step. The value emailMarketing should be used for simple campaigns, and contact for multi-step campaigns.
• campaignClassification(optional): string
  Campaign_Field_CampaignClassification_Description
• campaignType(optional): string
  The campaign's type.
• clrEndDate(optional): string
  The end date of the clr.
• createdAt(optional): string
  Read Only: true

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

  The login id of the user who created the campaign.
• crmId(optional): string
  The id of the customer relationship management application. When sending update requests, if crmId is not included in the request and a crmId value exists, it will be blanked.
• currentStatus(optional): string
  The campaign's current status: Active, Draft, Scheduled, or Completed.
• 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. For more information, see Request depth.
• description(optional): string
  The description of the campaign.
• elements(optional): array elements
  A list of campaign elements.
• endAt(optional): string
  The date and time the campaign will end.
• fieldValues(optional): array fieldValues
  Array containing type and id values for all of the contactFields associated with a given contact. For campaigns, "fieldValues" include all custom campaign fields (type, id, value).
• firstActivation(optional): string
  Read Only: true

  The date and time the campaign was originally activated.
• folderId(optional): string
  Read Only: true

  The folder id of the folder which contains the campaign.
• id(optional): string
  Read Only: true

  Id of the campaign.
• isEmailMarketingCampaign(optional): string
  Whether or not the campaign is an email marketing campaign.
• isExitHistoryDisabled(optional): string
  Campaign_Field_IsExitHistoryDisabled_Description
• isIncludedInROI(optional): string
  Whether or not the campaign is included in return on investment.
• isMemberAllowedReEntry(optional): string
  Whether or not members are allowed to re-enter the campaign.
• isReadOnly(optional): string
  Whether or not the campaign is read only.
• isSyncedWithCRM(optional): string
  Whether or not the campaign is synced with a customer relationship management application.
• isUpdatingCrmId(optional): string
  Campaign_Field_IsUpdatingCrmId_Description
• memberCount(optional): string
  Read Only: true

  The amount of members that entered the campaign in the last 90 days. This property is only returned when depth is set to partial or complete. This is a read-only property.
• name(optional): string
  The name of the campaign.
• permissions(optional): array permissions
  The permissions for the campaign granted to your current instance. This is a read-only property.
• product(optional): string
  The campaign's product value.
• referenceProduct(optional): string
  Campaign_Field_ReferenceProduct_Description
• region(optional): string
  The campaign's region value.
• runAsUserId(optional): string
  The login id of the user to activate the campaign.
• scheduledFor(optional): string
  Read Only: true

  The date the campaign is scheduled.
• sourceTemplateId(optional): string
  Id of the template used to create the asset.
• startAt(optional): string
  The date time for which the campaign will activate, expressed in Unix time.
• 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 campaign was last updated. This is a read-only property.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the campaign.

{
    "title":"Campaign",
    "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 campaign."
        },
        "currentStatus":{
            "type":"string",
            "description":"The campaign's current status: <code>Active</code>, <code>Draft</code>, <code>Scheduled</code>, or <code>Completed</code>."
        },
        "name":{
            "type":"string",
            "description":"The name of the campaign."
        },
        "description":{
            "type":"string",
            "description":"The description of the campaign."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the campaign granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the campaign."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the campaign."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the campaign was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the campaign."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the campaign was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the campaign 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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>. "
        },
        "elements":{
            "type":"array",
            "description":"A list of campaign elements.",
            "items":{
                "$ref":"#/definitions/CampaignElementRest20"
            }
        },
        "isReadOnly":{
            "type":"string",
            "description":"Whether or not the campaign is read only."
        },
        "runAsUserId":{
            "type":"string",
            "description":"The login id of the user to activate the campaign."
        },
        "isExitHistoryDisabled":{
            "type":"string",
            "description":"Campaign_Field_IsExitHistoryDisabled_Description"
        },
        "startAt":{
            "type":"string",
            "description":"The date time for which the campaign will activate, expressed in Unix time."
        },
        "endAt":{
            "type":"string",
            "description":"The date and time the campaign will end."
        },
        "budgetedCost":{
            "type":"string",
            "description":"The campaign's projected cost."
        },
        "actualCost":{
            "type":"string",
            "description":"The campaign's actual cost."
        },
        "isMemberAllowedReEntry":{
            "type":"string",
            "description":"Whether or not members are allowed to re-enter the campaign."
        },
        "fieldValues":{
            "type":"array",
            "description":"Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact. For campaigns, \"fieldValues\" include all custom campaign fields (type, id, value).",
            "items":{
                "$ref":"#/definitions/FieldValueRest20"
            }
        },
        "campaignType":{
            "type":"string",
            "description":"The campaign's type."
        },
        "product":{
            "type":"string",
            "description":"The campaign's product value."
        },
        "region":{
            "type":"string",
            "description":"The campaign's region value."
        },
        "clrEndDate":{
            "type":"string",
            "description":"The end date of the clr."
        },
        "adCampaignId":{
            "type":"string",
            "description":"Campaign_Field_AdCampaignId_Description"
        },
        "campaignClassification":{
            "type":"string",
            "description":"Campaign_Field_CampaignClassification_Description"
        },
        "referenceProduct":{
            "type":"string",
            "description":"Campaign_Field_ReferenceProduct_Description"
        },
        "crmId":{
            "type":"string",
            "description":"The id of the customer relationship management application. When sending update requests, if <code>crmId</code> is not included in the request and a <code>crmId</code> value exists, it will be blanked."
        },
        "isSyncedWithCRM":{
            "type":"string",
            "description":"Whether or not the campaign is synced with a customer relationship management application."
        },
        "isIncludedInROI":{
            "type":"string",
            "description":"Whether or not the campaign is included in return on investment."
        },
        "badgeId":{
            "type":"string",
            "description":"The badge id of the campaign."
        },
        "isEmailMarketingCampaign":{
            "type":"string",
            "description":"Whether or not the campaign is an email marketing campaign."
        },
        "campaignCategory":{
            "type":"string",
            "description":"Defines whether a Campaign is simple or multi-step. The value <code>emailMarketing</code> should be used for simple campaigns, and <code>contact</code> for multi-step campaigns."
        },
        "firstActivation":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the campaign was originally activated."
        },
        "memberCount":{
            "type":"string",
            "readOnly":true,
            "description":"The amount of members that entered the campaign in the last 90 days. This property is only returned when <code>depth</code> is set to <code>partial</code> or <code>complete</code>. This is a read-only property."
        },
        "isUpdatingCrmId":{
            "type":"string",
            "description":"Campaign_Field_IsUpdatingCrmId_Description"
        }
    }
}

• Array of: object CampaignElement
  Title: CampaignElement

{
    "type":"array",
    "description":"A list of campaign elements.",
    "items":{
        "$ref":"#/definitions/CampaignElementRest20"
    }
}

• Array of: object FieldValue
  Title: FieldValue

{
    "type":"array",
    "description":"Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact. For campaigns, \"fieldValues\" include all custom campaign fields (type, id, value).",
    "items":{
        "$ref":"#/definitions/FieldValueRest20"
    }
}

• Array of: string

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

• createdAt(optional): string
  Read Only: true

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

  The login id of the user who created the campaign element.
• currentStatus(optional): string
  The campaign 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 campaign element.
• folderId(optional): string
  Read Only: true

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

  Id of the campaign element. This is a read-only property.
• memberCount(optional): string
  Amount of members within the campaign element. This is a read-only property.
• memberErrorCount(optional): string
  Amount of members within the campaign element in errored status. This is a read-only property.
• name(optional): string
  Name of the campaign element. This is a read-only property.
• outputTerminals(optional): array outputTerminals
  A list of the campaign element ids within the campaign. This is a read-only property.
• permissions(optional): array permissions
  The permissions for the campaign element granted to your current instance. This is a read-only property.
• position(optional): object Position
  Title: Position
• scheduledFor(optional): string
  Read Only: true

  The date the campaign element 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 campaign element was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the campaign element.

{
    "title":"CampaignElement",
    "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 campaign element. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The campaign element's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the campaign element. This is a read-only property."
        },
        "description":{
            "type":"string",
            "description":"The description of the campaign element."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the campaign element granted to your current instance. This is a read-only property.",
            "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 campaign element."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the campaign element was created, expressed in Unix time. "
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the campaign element."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the campaign element was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the campaign 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'>Request depth</a>."
        },
        "position":{
            "$ref":"#/definitions/PositionRest20",
            "description":"Array of campaign element position fields."
        },
        "outputTerminals":{
            "type":"array",
            "description":"A list of the campaign element ids within the campaign. This is a read-only property.",
            "items":{
                "$ref":"#/definitions/CampaignOutputTerminalRest20"
            }
        },
        "memberCount":{
            "type":"string",
            "description":"Amount of members within the campaign element. This is a read-only property."
        },
        "memberErrorCount":{
            "type":"string",
            "description":"Amount of members within the campaign element in errored status. This is a read-only property."
        }
    }
}

• Array of: object CampaignOutputTerminal
  Title: CampaignOutputTerminal

{
    "type":"array",
    "description":"A list of the campaign element ids within the campaign. This is a read-only property.",
    "items":{
        "$ref":"#/definitions/CampaignOutputTerminalRest20"
    }
}

• Array of: string

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

• type(optional): string
  The campaign element's type. This is a read-only property.
• x(optional): string
  The position of the campaign element on the x axis.
• y(optional): string
  The position of the campaign element on the y axis.

{
    "title":"Position",
    "properties":{
        "type":{
            "type":"string",
            "description":"The campaign element's type. This is a read-only property."
        },
        "x":{
            "type":"string",
            "description":"The position of the campaign element on the x axis."
        },
        "y":{
            "type":"string",
            "description":"The position of the campaign element on the y axis."
        }
    }
}

• connectedId(optional): string
  The connected id of the campaign output terminal. This is a read-only property.
• connectedType(optional): string
  The campaign output terminal's connection type. This is a read-only property.
• createdAt(optional): string
  Read Only: true

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

  The login id of the user who created the campaign output terminal.
• currentStatus(optional): string
  The campaign output terminal'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. For more information, see Request depth.
• description(optional): string
  The description of the campaign output terminal.
• folderId(optional): string
  Read Only: true

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

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

  The date the campaign output terminal is scheduled.
• sourceTemplateId(optional): string
  The id of the source template.
• terminalType(optional): string
  The campaign output terminal type. 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 campaign output terminal was last updated. This is a read-only property.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the campaign output terminal.

{
    "title":"CampaignOutputTerminal",
    "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 campaign output terminal. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The campaign output terminal's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the campaign output terminal."
        },
        "description":{
            "type":"string",
            "description":"The description of the campaign output terminal."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the campaign output terminal 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 campaign output terminal."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the campaign output terminal was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the campaign output terminal."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the campaign output terminal was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the campaign output terminal 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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "terminalType":{
            "type":"string",
            "description":"The campaign output terminal type. This is a read-only property."
        },
        "connectedType":{
            "type":"string",
            "description":"The campaign output terminal's connection type. This is a read-only property."
        },
        "connectedId":{
            "type":"string",
            "description":"The connected id of the campaign output terminal. This is a read-only property."
        }
    }
}

• Array of: string

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

• id(optional): string
  Read Only: true

  The id of the field to be set to the corresponding value.
• name(optional): string
  Name of the field value.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• value(optional): string
  The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

{
    "title":"FieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "value":{
            "type":"string",
            "description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The id of the field to be set to the corresponding value."
        },
        "name":{
            "type":"string",
            "description":"Name of the field value."
        }
    }
}