Update a campaign response export definition

put

/api/bulk/2.0/campaignResponses/exports/{id}

Updates 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
Path Parameters
  • The campaign response export definition's resource identification number.
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
Nested Schema : fields
Type: array
Title: fields
List of fields to be included in the operation.
Show Source
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
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : CampaignResponseExportIndividualResponse
Type: object
Title: CampaignResponseExportIndividualResponse
The response body includes information about the campaign response export definition.
Show Source
Nested Schema : fields
Type: array
Title: fields
List of fields to be included in the operation.
Show Source
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

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 update an existing campaign response export definition using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Update a campaign response export definition where the id = 1:


PUT /campaignResponses/exports/1
Content-Type: application/json 
			

Request body:


{
  "name": "Example Campaign Response Export Update",
  "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 Update",
  "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_SFDCLeadID)}}",
    "ContactId": "{{CampaignResponse.Contact.Field(C_SFDCContactID)}}",
    "EmailAddress": "{{CampaignResponse.Contact.Field(C_EmailAddress)}}"
  },
  "filter": "STATUS('{{ActionInstance(7BE704D3AF604775AD416E8D0A5AB212).Execution[12345]}}') = 'pending'",
  "syncActions": [],
  "dataRetentionDuration": "PT12H",
  "uri": "/campaignResponses/exports/1",
  "createdBy": "API.User",
  "createdAt": "2017-11-21T17:20:07.9830000Z",
  "updatedBy": "API.User",
  "updatedAt": "2017-11-21T18:17:46.7428835Z"
}
			

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 Update","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_SFDCLeadID)}}","ContactId":"{{CampaignResponse.Contact.Field(C_SFDCContactID)}}","EmailAddress":"{{CampaignResponse.Contact.Field(C_EmailAddress)}}"},"filter":"STATUS('{{ActionInstance(7BE704D3AF604775AD416E8D0A5AB212).Execution[12345]}}') = 'pending'"}' https://secure.p03.eloqua.com/api/bulk/2.0/campaignResponses/exports/1
			
Back to Top