Update a contact import definition
put
/api/bulk/2.0/contacts/imports/{id}
Updates a contact import definition.
Request
Supported Media Types
- application/json
- text/csv
Path Parameters
-
id: integer
Part of the uri used to identify the contact import.
The request body contains details of the contact import definition.
Root Schema : ContactImportIndividual
Type:
object
Title:
ContactImportIndividual
The request body defines the details of the contact import definition.
Show Source
-
autoDeleteDuration(optional):
string
Title:
autoDeleteDuration
Time until the definition will be deleted, expressed using the ISO-8601 standard. -
createdAt(optional):
string(date-time)
Title:
createdAt
The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. -
createdBy(optional):
string
Title:
createdBy
The login id of the user who created the entity. This is a read-only property. -
dataRetentionDuration(optional):
string
Title:
dataRetentionDuration
The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. -
fields(optional):
array fields
Title:
fields
List of fields to be included in the operation. -
identifierFieldName(optional):
string
Title:
identifierFieldName
The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean. -
importPriorityUri(optional):
string
Title:
importPriorityUri
Must reference an existing/imports/priorities/{id}
. For more information about this parameter, see the Oracle Eloqua Developer Help Center. -
isSyncTriggeredOnImport(optional):
boolean
Title:
isSyncTriggeredOnImport
Whether or not the sync is triggered on import. -
isUpdatingMultipleMatchedRecords(optional):
boolean
Title:
isUpdatingMultipleMatchedRecords
Whether or not imported data will be mapped to multiple existing records. For contact imports, theisUpdatingMultipleMatchedRecords
property must be set tofalse
to updateContact.Field(C_EmailAddress)
. -
kbUsed(optional):
integer(int64)
Title:
kbUsed
The amount of space used in kilobytes. This is a read-only property. -
name(optional):
string
Title:
name
The name of the import definition. -
nullIdentifierFieldName(optional):
boolean
Title:
nullIdentifierFieldName
Whether or not to null the identifier field. -
syncActions(optional):
array syncActions
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. There currently are not any sync actions available for Events. -
updatedAt(optional):
string(date-time)
Title:
updatedAt
The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. -
updatedBy(optional):
string
Title:
updatedBy
The login id of the user that last updated the entity. This is a read-only property. -
updateRule(optional):
string
Title:
RuleType
Default Value:always
Allowed Values:[ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ]
The rule used when doing updates on existing data. For more information about this parameter, see the Oracle Eloqua Developer Help Center. -
uri(optional):
string
Title:
uri
System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
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.
There currently are not any sync actions available for Events.
Show Source
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : ContactImportIndividualResponse
Type:
object
Title:
ContactImportIndividualResponse
The response body includes information about the contact import definition.
Show Source
-
autoDeleteDuration(optional):
string
Title:
autoDeleteDuration
Time until the definition will be deleted, expressed using the ISO-8601 standard. -
createdAt(optional):
string(date-time)
Title:
createdAt
The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. -
createdBy(optional):
string
Title:
createdBy
The login id of the user who created the entity. This is a read-only property. -
dataRetentionDuration(optional):
string
Title:
dataRetentionDuration
The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. -
fields(optional):
array fields
Title:
fields
List of fields to be included in the operation. -
identifierFieldName(optional):
string
Title:
identifierFieldName
The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean. -
importPriorityUri(optional):
string
Title:
importPriorityUri
Must reference an existing/imports/priorities/{id}
. For more information about this parameter, see the Oracle Eloqua Developer Help Center. -
isSyncTriggeredOnImport(optional):
boolean
Title:
isSyncTriggeredOnImport
Whether or not the sync is triggered on import. -
isUpdatingMultipleMatchedRecords(optional):
boolean
Title:
isUpdatingMultipleMatchedRecords
Whether or not imported data will be mapped to multiple existing records. For contact imports, theisUpdatingMultipleMatchedRecords
property must be set tofalse
to updateContact.Field(C_EmailAddress)
. -
kbUsed(optional):
integer(int64)
Title:
kbUsed
The amount of space used in kilobytes. This is a read-only property. -
name(optional):
string
Title:
name
The name of the import definition. -
nullIdentifierFieldName(optional):
boolean
Title:
nullIdentifierFieldName
Whether or not to null the identifier field. -
syncActions(optional):
array syncActions
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. There currently are not any sync actions available for Events. -
updatedAt(optional):
string(date-time)
Title:
updatedAt
The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. -
updatedBy(optional):
string
Title:
updatedBy
The login id of the user that last updated the entity. This is a read-only property. -
updateRule(optional):
string
Title:
RuleType
Default Value:always
Allowed Values:[ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ]
The rule used when doing updates on existing data. For more information about this parameter, see the Oracle Eloqua Developer Help Center. -
uri(optional):
string
Title:
uri
System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
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.
There currently are not any sync actions available for Events.
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.
Examples
Use an import's ID to update its name and fields:
PUT /contacts/imports/29686
Content-Type: application/json
Request body:
{
"name":"Contact Name Import",
"fields":{
"FirstName":"{{Contact.Field(C_FirstName)}}",
"LastName":"{{Contact.Field(C_LastName)}}"
},
"identifierFieldName": "FirstName"
}
Response:
{
"name":"Contact Name Import",
"fields":{
"FirstName":"{{Contact.Field(C_FirstName)}}",
"LastName":"{{Contact.Field(C_LastName)}}"
},
"identifierFieldName":"FirstName",
"syncActions":[
],
"isSyncTriggeredOnImport":false,
"dataRetentionDuration":"P7D",
"isUpdatingMultipleMatchedRecords":false,
"uri":"/contacts/imports/29686",
"createdBy":"API.User",
"createdAt":"2015-08-21T20:07:05.9200000Z",
"updatedBy":"API.User",
"updatedAt":"2015-08-21T20:12:44.4438586Z"
}