Update an import definition for a custom object

put

/api/bulk/2.0/customObjects/{parentId}/imports/{id}

Updates the specified import definition for the specified custom object.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : CustomObjectImportIndividual
Type: object
Title: CustomObjectImportIndividual
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

200 Response

OK.
Body ()
Root Schema : CustomObjectImportIndividualResponse
Type: object
Title: CustomObjectImportIndividualResponse
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 update a custom object import definition using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Update the import definition with the id #32082 for the custom object with id #9:


PUT /customObjects/9/imports/32082
Content-Type: application/json 
			

Request body:


{
  "name": "Hot Air Balloon Import",
  "fields": {
    "NEW_FIELD": "{{CustomObject[9].Field[99]}}",
    "ID": "{{CustomObject[9].ExternalId}}"
  },
  "identifierFieldName": "ID"
}
			

Response:


{
  "id": 32082,
  "parentId": 9,
  "mapDataCardsCaseSensitiveMatch": false,
  "name": "Hot Air Balloon Import",
  "fields": {
    "NEW_FIELD": "{{CustomObject[9].Field[99]}}",
    "ID": "{{CustomObject[9].ExternalId}}"
  },
  "identifierFieldName": "ID",
  "syncActions": [
    
  ],
  "isSyncTriggeredOnImport": false,
  "dataRetentionDuration": "P7D",
  "isUpdatingMultipleMatchedRecords": false,
  "uri": "/customObjects/9/imports/32082",
  "createdBy": "API.User",
  "createdAt": "2015-09-15T19:27:02.3570000Z",
  "updatedBy": "API.User",
  "updatedAt": "2015-09-15T19:36:50.9368454Z"
}
			

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 PUT --data '{"name":"Hot Air Balloon Import","fields":{"NEW_FIELD":"{{CustomObject[9].Field[99]}}","ID":"{{CustomObject[9].ExternalId}}"}"identifierFieldName":"ID"}' https://secure.p03.eloqua.com/api/bulk/2.0/customObjects/9/imports/32082
			
Back to Top