Create a contact export definition

post

/api/bulk/2.0/contacts/exports

Creates a new contact export definition. See the tutorial for details on how to export data.

Request

Supported Media Types
Body ()
The request body contains details of the contact export definition.
Root Schema : ContactExportIndividual
Type: object
Title: ContactExportIndividual
The request body defines details of the contact 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

201 Response

Success.
Body ()
Root Schema : ContactExportIndividualResponse
Type: object
Title: ContactExportIndividualResponse
The response body contains information about the contact 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 create a new contact export definition using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Create a new contact export definition to export a list of lead scoring fields from the lead scoring model with id#1 and email addresses:


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

Request body:


{
    "name": "Contact Lead Score Export",
    "fields": {
        "Rating": "{{Contact.LeadScore.Model[1].Rating}}",
        "Profile": "{{Contact.LeadScore.Model[1].ProfileScore}}",
        "Engagement": "{{Contact.LeadScore.Model[1].EngagementScore}}",
        "EmailAddress": "{{Contact.Field(C_EmailAddress)}}"
    }
}
			

Response:


{
    "name": "Contact Lead Score Export",
    "fields": {
        "Rating": "{{Contact.LeadScore.Model[1].Rating}}",
        "Profile": "{{Contact.LeadScore.Model[1].ProfileScore}}",
        "Engagement": "{{Contact.LeadScore.Model[1].EngagementScore}}",
        "EmailAddress": "{{Contact.Field(C_EmailAddress)}}"
    },
    "dataRetentionDuration": "PT12H",
    "uri": "/contacts/exports/29588",
    "createdBy": "Api.User",
    "createdAt": "2015-08-19T20:51:28.8201911Z",
    "updatedBy": "Api.User",
    "updatedAt": "2015-08-19T20:51:28.8201911Z"
}
			

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":"Contact Lead Score Export","fields":{"Rating":"{{Contact.LeadScore.Model[1].Rating}}","Profile":"{{Contact.LeadScore.Model[1].ProfileScore}}","Engagement":"{{Contact.LeadScore.Model[1].EngagementScore}}","EmailAddress":"{{Contact.Field(C_EmailAddress)}}"}}' https://secure.p03.eloqua.com/api/bulk/2.0/contacts/exports
			

Note that only one lead scoring model can be used per contact export definition.

Back to Top