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
- application/json
- text/csv
Root Schema : CampaignResponseExportIndividual
Type:
object
Title:
Show Source
CampaignResponseExportIndividual
-
areSystemTimestampsInUTC:
boolean
Title:
areSystemTimestampsInUTC
-
autoDeleteDuration:
string
Title:
autoDeleteDuration
-
createdAt:
string(date-time)
Title:
createdAt
-
createdBy:
string
Title:
createdBy
-
crmAccountIdField:
string
Title:
crmAccountIdField
-
dataRetentionDuration:
string
Title:
dataRetentionDuration
-
externalSystemId:
integer
Title:
externalSystemId
-
fields:
object fields
Title:
fields
-
filter:
string
Title:
filter
-
kbUsed:
integer(int64)
Title:
kbUsed
-
maxRecords:
integer
Title:
maxRecords
-
name:
string
Title:
name
-
productIdField:
string
Title:
productIdField
-
syncActions:
array syncActions
Title:
syncActions
-
updatedAt:
string(date-time)
Title:
updatedAt
-
updatedBy:
string
Title:
updatedBy
-
uri:
string
Title:
uri
Nested Schema : fields
Type:
object
Title:
fields
Nested Schema : syncActions
Type:
array
Title:
Show Source
syncActions
-
Array of:
object SyncAction
Title:
SyncAction
Nested Schema : SyncAction
Type:
object
Title:
Show Source
SyncAction
-
action:
string
Title:
SyncActionType
Default Value:add
Allowed Values:[ "add", "remove", "setStatus" ]
-
destination:
string
Title:
destination
-
status:
string
Title:
MemberStatus
Default Value:bounced
Allowed Values:[ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
-
updateAll:
boolean
Title:
updateAll
Response
Supported Media Types
- application/json
201 Response
OK.
Root Schema : CampaignResponseExportIndividualResponse
Type:
object
Title:
Show Source
CampaignResponseExportIndividualResponse
-
areSystemTimestampsInUTC:
boolean
Title:
areSystemTimestampsInUTC
-
autoDeleteDuration:
string
Title:
autoDeleteDuration
-
createdAt:
string(date-time)
Title:
createdAt
-
createdBy:
string
Title:
createdBy
-
crmAccountIdField:
string
Title:
crmAccountIdField
-
dataRetentionDuration:
string
Title:
dataRetentionDuration
-
externalSystemId:
integer
Title:
externalSystemId
-
fields:
object fields
Title:
fields
-
filter:
string
Title:
filter
-
kbUsed:
integer(int64)
Title:
kbUsed
-
maxRecords:
integer
Title:
maxRecords
-
name:
string
Title:
name
-
productIdField:
string
Title:
productIdField
-
syncActions:
array syncActions
Title:
syncActions
-
updatedAt:
string(date-time)
Title:
updatedAt
-
updatedBy:
string
Title:
updatedBy
-
uri:
string
Title:
uri
Nested Schema : fields
Type:
object
Title:
fields
Nested Schema : syncActions
Type:
array
Title:
Show Source
syncActions
-
Array of:
object SyncAction
Title:
SyncAction
Nested Schema : SyncAction
Type:
object
Title:
Show Source
SyncAction
-
action:
string
Title:
SyncActionType
Default Value:add
Allowed Values:[ "add", "remove", "setStatus" ]
-
destination:
string
Title:
destination
-
status:
string
Title:
MemberStatus
Default Value:bounced
Allowed Values:[ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
-
updateAll:
boolean
Title:
updateAll
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.
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