1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Bulk
  4. 2.0
  5. campaignResponses

Create a campaign response export definition

post

/api/bulk/2.0/campaignResponses/exports

Creates a campaign response export definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.

Request

Supported Media Types
Body ()
The request body contains details of the campaign response export definition.
Root Schema : CampaignResponseExportIndividual
Type: object
Title: CampaignResponseExportIndividual
The request body defines the details of the campaign response export definition.
Show Source
  • Title: areSystemTimestampsInUTC
    Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.
  • Title: autoDeleteDuration
    Time until the definition will be deleted, expressed using the ISO-8601 standard.
  • Title: createdAt
    The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: createdBy
    The login id of the user who created the entity. This is a read-only property.
  • Title: crmAccountIdField
    The ML statement for an existing contact field which addresses the CRM account ID.
  • Title: dataRetentionDuration
    The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
  • Title: externalSystemId
    The external system ID is used when exporting data containing CRM fields.
  • fields
    Title: fields
    List of fields to be included in the operation.
  • Title: filter
    The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.
  • Title: kbUsed
    The amount of space used in kilobytes. This is a read-only property.
  • Title: maxRecords
    The maximum amount of records.
  • Title: name
    The name of the export definition.
  • Title: productIdField
    The ML statement for an existing campaign field which addresses the product ID.
  • syncActions
    Title: syncActions
    Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
  • Title: updatedAt
    The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: updatedBy
    The login id of the user that last updated the entity. This is a read-only property.
  • Title: uri
    System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
Nested Schema : fields
Type: object
Title: fields
List of fields to be included in the operation.
Nested Schema : syncActions
Type: array
Title: syncActions
Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
Show Source
Nested Schema : SyncAction
Type: object
Title: SyncAction
The definition of the action to take at time of syncronization.
Show Source
  • Title: SyncActionType
    Default Value: add
    Allowed Values: [ "add", "remove", "setStatus" ]
    The action to take at time of synchronization.
  • Title: destination
    The ML statement used to reference an object used by the action.
  • Title: MemberStatus
    Default Value: bounced
    Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
    The status of members.
  • Title: updateAll
    Update status of all records in an execution.
Back to Top

Response

Supported Media Types

201 Response

OK.
Body ()
Root Schema : CampaignResponseExportIndividualResponse
Type: object
Title: CampaignResponseExportIndividualResponse
The response body includes information about the campaign response export definition.
Show Source
  • Title: areSystemTimestampsInUTC
    Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.
  • Title: autoDeleteDuration
    Time until the definition will be deleted, expressed using the ISO-8601 standard.
  • Title: createdAt
    The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: createdBy
    The login id of the user who created the entity. This is a read-only property.
  • Title: crmAccountIdField
    The ML statement for an existing contact field which addresses the CRM account ID.
  • Title: dataRetentionDuration
    The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
  • Title: externalSystemId
    The external system ID is used when exporting data containing CRM fields.
  • fields
    Title: fields
    List of fields to be included in the operation.
  • Title: filter
    The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.
  • Title: kbUsed
    The amount of space used in kilobytes. This is a read-only property.
  • Title: maxRecords
    The maximum amount of records.
  • Title: name
    The name of the export definition.
  • Title: productIdField
    The ML statement for an existing campaign field which addresses the product ID.
  • syncActions
    Title: syncActions
    Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
  • Title: updatedAt
    The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: updatedBy
    The login id of the user that last updated the entity. This is a read-only property.
  • Title: uri
    System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
Nested Schema : fields
Type: object
Title: fields
List of fields to be included in the operation.
Nested Schema : syncActions
Type: array
Title: syncActions
Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
Show Source
Nested Schema : SyncAction
Type: object
Title: SyncAction
The definition of the action to take at time of syncronization.
Show Source
  • Title: SyncActionType
    Default Value: add
    Allowed Values: [ "add", "remove", "setStatus" ]
    The action to take at time of synchronization.
  • Title: destination
    The ML statement used to reference an object used by the action.
  • Title: MemberStatus
    Default Value: bounced
    Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
    The status of members.
  • Title: updateAll
    Update status of all records in an execution.

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.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

The following examples demonstrate how to create a new campaign response export definition using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Create a new campaign response export definition:


POST /campaignResponses/exports
Content-Type: application/json

Request body:


{
  "name": "Example Campaign Response Export",
  "fields": {
    "CampaignResponseId": "{{CampaignResponse.Id}}",
    "MemberStatus": "{{CampaignResponse.Field(MemberStatus)}}",
    "CampaignMembershipId": "{{CampaignResponse.Field(IntegrationReturnValue)}}",
    "CreatedAt": "{{CampaignResponse.CreatedAt}}",
    "CRMCampaignId": "{{CampaignResponse.Campaign.Field(CRMCampaignId)}}",
    "EloquaCampaignId": "{{CampaignResponse.Campaign.Id}}",
    "EloquaCampaignName": "{{CampaignResponse.Campaign.Field(CampaignName)}}",
    "LeadId": "{{CampaignResponse.Contact.Field(C_OracleFusionLeadID)}}",
    "ContactId": "{{CampaignResponse.Contact.Field(C_OracleFusionContactID)}}",
    "EmailAddress": "{{CampaignResponse.Contact.Field(C_EmailAddress)}}"
  },
  "filter": "STATUS('{{ActionInstance(7BE704D3AF604775AD416E8D0A5AB212).Execution[12345]}}') = 'pending'"
}

Note:

In the filter, your service instance ID must be specified, and your service instance ID has to be selected to consume campaign responses, or else a validation error will be returned. This export requires records to be in the step. In the filter, a valid execution ID is also required. A validation error will be returned if there is not a valid execution ID. For more information, see Developing for campaign responses.

Response:


{
  "name": "Example Campaign Response Export",
  "fields": {
    "CampaignResponseId": "{{CampaignResponse.Id}}",
    "MemberStatus": "{{CampaignResponse.Field(MemberStatus)}}",
    "CampaignMembershipId": "{{CampaignResponse.Field(IntegrationReturnValue)}}",
    "CreatedAt": "{{CampaignResponse.CreatedAt}}",
    "CRMCampaignId": "{{CampaignResponse.Campaign.Field(CRMCampaignId)}}",
    "EloquaCampaignId": "{{CampaignResponse.Campaign.Id}}",
    "EloquaCampaignName": "{{CampaignResponse.Campaign.Field(CampaignName)}}",
    "LeadId": "{{CampaignResponse.Contact.Field(C_OracleFusionLeadID)}}",
    "ContactId": "{{CampaignResponse.Contact.Field(C_OracleFusionContactID)}}",
    "EmailAddress": "{{CampaignResponse.Contact.Field(C_EmailAddress)}}"
  },
  "filter": "STATUS('{{ActionInstance(7BE704D3AF604775AD416E8D0A5AB212).Execution[12345]}}') = 'pending'",
  "dataRetentionDuration": "PT12H",
  "uri": "/campaignResponses/exports/1836",
  "createdBy": "API.User",
  "createdAt": "2017-11-21T17:20:07.9831191Z",
  "updatedBy": "API.User",
  "updatedAt": "2017-11-21T17:20:07.9831191Z"
}

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3. 


curl --user "APITest\API.User" --header "Content-Type: application/json" --request POST --data '{"name":"Example Campaign Response Export","fields":{"CampaignResponseId":"{{CampaignResponse.Id}}","MemberStatus":"{{CampaignResponse.Field(MemberStatus)}}","CampaignMembershipId":"{{CampaignResponse.Field(IntegrationReturnValue)}}","CreatedAt":"{{CampaignResponse.CreatedAt}}","CRMCampaignId":"{{CampaignResponse.Campaign.Field(CRMCampaignId)}}","EloquaCampaignId":"{{CampaignResponse.Campaign.Id}}","EloquaCampaignName":"{{CampaignResponse.Campaign.Field(CampaignName)}}","LeadId":"{{CampaignResponse.Contact.Field(C_OracleFusionLeadID)}}","ContactId":"{{CampaignResponse.Contact.Field(C_OracleFusionContactID)}}","EmailAddress":"{{CampaignResponse.Contact.Field(C_EmailAddress)}}"},"filter":"STATUS('{{ActionInstance(7BE704D3AF604775AD416E8D0A5AB212).Execution[12345]}}') = 'pending'"}' https://secure.p03.eloqua.com/api/bulk/2.0/campaignResponses/exports
Back to Top