Update an opportunity import definition
put
/api/bulk/2.0/opportunities/imports/{id}
Updates an opportunity import definition. For more information about using these endpoints, see, using the opportunities endpoints.
Request
Supported Media Types
- application/json
- text/csv
Path Parameters
Root Schema : OpportunityImportIndividual
Type:
objectTitle:
Show Source
OpportunityImportIndividual-
autoDeleteDuration(optional):
string
Title:
autoDeleteDuration -
createdAt(optional):
string(date-time)
Title:
createdAt -
createdBy(optional):
string
Title:
createdBy -
dataRetentionDuration(optional):
string
Title:
dataRetentionDuration -
externalSystemId(optional):
integer
Title:
externalSystemId -
fields(optional):
object fields
Title:
fields -
identifierFieldName(optional):
string
Title:
identifierFieldName -
importPriorityUri(optional):
string
Title:
importPriorityUri -
isIdentifierFieldCaseSensitive(optional):
boolean
Title:
isIdentifierFieldCaseSensitive -
isSyncTriggeredOnImport(optional):
boolean
Title:
isSyncTriggeredOnImport -
isUpdatingMultipleMatchedRecords(optional):
boolean
Title:
isUpdatingMultipleMatchedRecords -
kbUsed(optional):
integer(int64)
Title:
kbUsed -
name(optional):
string
Title:
name -
nullIdentifierFieldName(optional):
boolean
Title:
nullIdentifierFieldName -
updatedAt(optional):
string(date-time)
Title:
updatedAt -
updatedBy(optional):
string
Title:
updatedBy -
updateRule(optional):
string
Title:
RuleTypeDefault Value:alwaysAllowed Values:[ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ] -
updateRuleByField(optional):
object updateRuleByField
Title:
updateRuleByField -
uri(optional):
string
Title:
uri
Nested Schema : fields
Type:
objectTitle:
fieldsNested Schema : updateRuleByField
Type:
objectTitle:
updateRuleByFieldResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : OpportunityImportIndividualResponse
Type:
objectTitle:
Show Source
OpportunityImportIndividualResponse-
autoDeleteDuration(optional):
string
Title:
autoDeleteDuration -
createdAt(optional):
string(date-time)
Title:
createdAt -
createdBy(optional):
string
Title:
createdBy -
dataRetentionDuration(optional):
string
Title:
dataRetentionDuration -
externalSystemId(optional):
integer
Title:
externalSystemId -
fields(optional):
object fields
Title:
fields -
identifierFieldName(optional):
string
Title:
identifierFieldName -
importPriorityUri(optional):
string
Title:
importPriorityUri -
isIdentifierFieldCaseSensitive(optional):
boolean
Title:
isIdentifierFieldCaseSensitive -
isSyncTriggeredOnImport(optional):
boolean
Title:
isSyncTriggeredOnImport -
isUpdatingMultipleMatchedRecords(optional):
boolean
Title:
isUpdatingMultipleMatchedRecords -
kbUsed(optional):
integer(int64)
Title:
kbUsed -
name(optional):
string
Title:
name -
nullIdentifierFieldName(optional):
boolean
Title:
nullIdentifierFieldName -
updatedAt(optional):
string(date-time)
Title:
updatedAt -
updatedBy(optional):
string
Title:
updatedBy -
updateRule(optional):
string
Title:
RuleTypeDefault Value:alwaysAllowed Values:[ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ] -
updateRuleByField(optional):
object updateRuleByField
Title:
updateRuleByField -
uri(optional):
string
Title:
uri
Nested Schema : fields
Type:
objectTitle:
fieldsNested Schema : updateRuleByField
Type:
objectTitle:
updateRuleByField400 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
The following examples demonstrate how to update an opportunity import definition using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Update the opportunity import definition with id #17:
PUT /opportunity/imports/17
Content-Type: application/json
Request body:
{
"name": "Example Opportunity Import Update",
"fields": {
"OpportunityID": "{{Opportunity.Id}}",
"OpportunityName": "{{Opportunity.Field(Name)}}",
"AccountName": "{{Opportunity.Field(AccountName)}}",
"Amount": "{{Opportunity.Field(Amount)}}",
"Stage": "{{Opportunity.Field(Stage)}}"
},
"identifierFieldName": "OpportunityID",
"linkOpportunities": "true",
"linkOpportunitiesEntityField": "{{Contact.Field(Opportunity.Id)}}",
"linkOpportunitiesSourceField": "OpportunityID",
"linkOpportunitiesEntityType": "Contact",
"linkOpportunitiesCaseSensitiveMatch": "false"
}
The request body must contain the following opportunity fields:
- {{Opportunity.Id}}
- {{Opportunity.Field(Name)}}
- {{Opportunity.Field(Stage)}}
- {{Opportunity.Field(Amount)}}
The request body must also contain identifierFieldName with the {{Opportunity.Id}} field in the fields.
Response:
{
"isIdentifierFieldCaseSensitive": false,
"name": "Example Opportunity Import Update",
"fields": {
"OpportunityID": "{{Opportunity.Id}}",
"OpportunityName": "{{Opportunity.Field(Name)}}",
"AccountName": "{{Opportunity.Field(AccountName)}}",
"Amount": "{{Opportunity.Field(Amount)}}",
"Stage": "{{Opportunity.Field(Stage)}}"
},
"identifierFieldName": "OpportunityID",
"syncActions": [],
"isSyncTriggeredOnImport": false,
"dataRetentionDuration": "P7D",
"uri": "/opportunities/imports/17",
"createdBy": "API.User",
"createdAt": "2018-02-08T14:56:13.9170000Z",
"updatedBy": "API.User",
"updatedAt": "2018-02-08T15:06:25.9893592Z"
}
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 Opportunity Import Update","fields":{"OpportunityID":"{{Opportunity.Id}}","OpportunityName":"{{Opportunity.Field(Name)}}","AccountName":"{{Opportunity.Field(AccountName)}}","Amount":"{{Opportunity.Field(Amount)}}","Stage":"{{Opportunity.Field(Stage)}}"},"identifierFieldName":"OpportunityID","linkOpportunities":"true","linkOpportunitiesEntityField":"{{Contact.Field(Opportunity.Id)}}","linkOpportunitiesSourceField":"OpportunityID","linkOpportunitiesEntityType":"Contact","linkOpportunitiesCaseSensitiveMatch":"false"}' https://secure.p03.eloqua.com/api/bulk/2.0/opportunities/imports/17