Create a contact import definition

post

/api/bulk/2.0/contacts/imports

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

Request

Supported Media Types
Body ()
Root Schema : ContactImportIndividual
Type: object
Title: ContactImportIndividual
Show Source
Nested Schema : fields
Type: array
Title: fields
Show Source
Nested Schema : syncActions
Type: array
Title: syncActions
Show Source
Nested Schema : updateRuleByField
Type: array
Title: updateRuleByField
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : ContactImportIndividualResponse
Type: object
Title: ContactImportIndividualResponse
Show Source
Nested Schema : fields
Type: array
Title: fields
Show Source
Nested Schema : syncActions
Type: array
Title: syncActions
Show Source
Nested Schema : updateRuleByField
Type: array
Title: updateRuleByField
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 import definition using an HTTP request and cURL. For more information on requests, see API requests. See the tutorial for details on how to import data.

HTTP Request Example

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


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

Request body:

Request body notes:

  • The isUpdatingMultipleMatchedRecords property must be set to false in order to update Contact.Field(C_EmailAddress).

{
   "name":"Contact Name Import",
   "fields":{
      "FirstName":"{{Contact.Field(C_FirstName)}}"
   },
  "identifierFieldName": "FirstName"
}
			

Response:


{
    "name":"Contact Name Import",
    "fields":{
        "FirstName":"{{Contact.Field(C_FirstName)}}"
    },
    "identifierFieldName":"FirstName",
    "isSyncTriggeredOnImport":false,
    "dataRetentionDuration":"P7D",
    "isUpdatingMultipleMatchedRecords":false,
    "uri":"/contacts/imports/29686",
    "createdBy":"API.User",
    "createdAt":"2015-08-21T20:07:05.9198818Z",
    "updatedBy":"API.User",
    "updatedAt":"2015-08-21T20:07:05.9198818Z"
}
			

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 Name Import","fields":{"FirstName":"{{Contact.Field(C_FirstName)}}"},"identifierFieldName":"FirstName"}' https://secure.p03.eloqua.com/api/bulk/2.0/contacts/imports
			
Back to Top