openapi: 3.2.0 info: title: REST API for Oracle Eloqua Marketing Cloud Service Application/2.0/Campaigns API description: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers. version: 2026.08.07 x-summary: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers. tags: - name: Application/2.0/Campaigns description: 'Marketing campaigns are at the center of the Eloqua application, campaigns are comprised of different elements (such as segments, emails, landing pages, etc.) that are used to perform a variety of functions. You can combine the different elements in a number of ways to customize your campaign flow. Learn more about campaigns.' paths: /api/rest/2.0/assets/campaign: post: operationId: CreateIndividualPOSTRest20 parameters: - name: externalSystemId in: query description: ICampaignService_Parameter_CreateIndividual_externalSystemId_Description required: false schema: type: integer summary: Create a campaign description: Creates a campaign that matches the criteria specified by the request body. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CampaignRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Campaigns x-internal-id: api-rest-2.0-assets-campaign-post x-filename-id: api-rest-2.0-assets-campaign-post requestBody: content: application/json: schema: $ref: '#/components/schemas/CampaignRest20' description: The request body defines the details of the campaign to be created. required: true /api/rest/2.0/assets/campaign/{id}: get: operationId: ReadIndividualGETRest20 parameters: - name: id in: path description: Id of the campaign. required: true schema: type: integer - name: depth in: query description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.' required: false schema: type: string - name: externalSystemId in: query description: ICampaignService_Parameter_ReadIndividual_externalSystemId_Description required: false schema: type: integer - name: includeCrmIdsMapping in: query description: ICampaignService_Parameter_ReadIndividual_includeCrmIdsMapping_Description required: false schema: type: boolean summary: Retrieve a campaign description: Retrieves a single campaign specified by the id parameter. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CampaignRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Campaigns x-internal-id: api-rest-2.0-assets-campaign-{id}-get x-filename-id: api-rest-2.0-assets-campaign-id-get put: operationId: UpdateIndividualPUTRest20 parameters: - name: id in: path description: Id of the campaign. required: true schema: type: string - name: externalSystemId in: query description: ICampaignService_Parameter_UpdateIndividual_externalSystemId_Description required: false schema: type: integer summary: Update a campaign description: Updates a campaign specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CampaignRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Campaigns x-internal-id: api-rest-2.0-assets-campaign-{id}-put x-filename-id: api-rest-2.0-assets-campaign-id-put requestBody: content: application/json: schema: $ref: '#/components/schemas/CampaignRest20' description: The request body defines the details of the campaign to be updated. required: true delete: operationId: DeleteIndividualDELETERest20 parameters: - name: id in: path description: Id of the campaign. required: true schema: type: integer summary: Delete a campaign description: Deletes a campaign specified by the id parameter. responses: '200': description: OK '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Campaigns x-internal-id: api-rest-2.0-assets-campaign-{id}-delete x-filename-id: api-rest-2.0-assets-campaign-id-delete /api/rest/2.0/assets/campaign/active/{id}: post: operationId: ActivateIndividualPOSTRest20 parameters: - name: scheduledFor in: query description: The date and time for the campaign to activate on expressed in Unix time. Alternatively, you can activate the campaign immediately by specifying 'now'. required: false schema: type: string - name: id in: path description: Id of the campaign. required: true schema: type: integer - name: runAsUserId in: query description: The username to activate the campaign. required: false schema: type: integer - name: activateNow in: query description: Whether or not to activate the campaign immediately. required: false schema: type: boolean summary: Activate a campaign description: Activates a campaign specified by the id parameter. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CampaignRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Campaigns x-internal-id: api-rest-2.0-assets-campaign-active-{id}-post x-filename-id: api-rest-2.0-assets-campaign-active-id-post /api/rest/2.0/assets/campaign/draft/{id}: post: operationId: DeactivateIndividualPOSTRest20 parameters: - name: id in: path description: Id of the campaign. required: true schema: type: integer summary: Deactivate a campaign description: Deactivates a campaign specified by the id parameter. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CampaignRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Campaigns x-internal-id: api-rest-2.0-assets-campaign-draft-{id}-post x-filename-id: api-rest-2.0-assets-campaign-draft-id-post /api/rest/2.0/assets/campaigns: get: operationId: SearchGETRest20 parameters: - name: depth in: query description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.' required: false schema: type: string - name: count in: query description: Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1. required: false schema: type: integer - name: page in: query description: Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default. required: false schema: type: integer - name: search in: query description: Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter. required: false schema: type: string - name: orderBy in: query description: Specifies the field by which list results are ordered. required: false schema: type: string - name: lastUpdatedAt in: query description: The date and time the campaign was last updated. required: false schema: type: integer - name: externalSystemId in: query description: ICampaignService_Parameter_Search_externalSystemId_Description required: false schema: type: integer - name: includeCrmIdsMapping in: query description: ICampaignService_Parameter_Search_includeCrmIdsMapping_Description required: false schema: type: boolean summary: Retrieve a list of campaigns description: Retrieves all campaigns that match the criteria specified by the request parameters. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/QueryResultCampaignRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Campaigns x-internal-id: api-rest-2.0-assets-campaigns-get x-filename-id: api-rest-2.0-assets-campaigns-get components: schemas: CampaignOutputTerminalRest20: 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. createdByName: type: string description: The name 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. updatedByName: type: string description: The name of the user who 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: minimal, partial, and complete. For more information, see Request depth.' 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. FieldValueRest20: 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. ExternalCampaignMappingRest20: title: ExternalCampaignMapping properties: type: type: string externalSystemId: type: integer value: type: string QueryResultCampaignRest20: title: QueryResultCampaign properties: type: type: string description: The asset's type in Eloqua. elements: type: array description: Array of campaign fields. items: $ref: '#/components/schemas/CampaignRest20' total: type: integer description: The total amount of results. pageSize: type: integer description: The page size. page: type: integer description: The specified page. CampaignElementRest20: 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. createdByName: type: string description: The name 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. updatedByName: type: string description: The name of the user who 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: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.' position: $ref: '#/components/schemas/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: '#/components/schemas/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. CampaignRest20: 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: Active, Draft, Scheduled, or Completed.' 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. createdByName: type: string description: The name 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. updatedByName: type: string description: The name of the user who 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: minimal, partial, and complete. For more information, see Request depth. ' elements: type: array description: A list of campaign elements. items: $ref: '#/components/schemas/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 isBypassHistoryDisabled: type: string description: Campaign_Field_IsBypassHistoryDisabled_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 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). items: $ref: '#/components/schemas/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 crmId is not included in the request and a crmId value exists, it will be blanked. crmIds: type: array description: Campaign_Field_crmIds_Description items: $ref: '#/components/schemas/ExternalCampaignMappingRest20' 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 emailMarketing should be used for simple campaigns, and contact 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 depth is set to partial or complete. This is a read-only property. isUpdatingCrmId: type: string description: Campaign_Field_IsUpdatingCrmId_Description PositionRest20: 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.