Jump to

• Request
• Response
• Examples

Update an opportunity contact linkage import definition

put

/api/bulk/2.0/opportunities/contacts/imports/{id}

Updates an opportunity contact linkage import definition. For more information about using these endpoints, see, using the opportunities endpoints.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer

Body ()

Root Schema : OpportunityContactLinkageImportIndividual

Type: object

Title: OpportunityContactLinkageImportIndividual

Show Source

• autoDeleteDuration: string
  Title: autoDeleteDuration
• createdAt: string(date-time)
  Title: createdAt
• createdBy: string
  Title: createdBy
• dataRetentionDuration: string
  Title: dataRetentionDuration
• externalSystemId: integer
  Title: externalSystemId
• fields: object fields
  Title: fields
• identifierFieldName: string
  Title: identifierFieldName
• importPriorityUri: string
  Title: importPriorityUri
• isSyncTriggeredOnImport: boolean
  Title: isSyncTriggeredOnImport
• isUpdatingMultipleMatchedRecords: boolean
  Title: isUpdatingMultipleMatchedRecords
• kbUsed: integer(int64)
  Title: kbUsed
• linkOpportunitiesCaseSensitiveMatchField: boolean
  Title: linkOpportunitiesCaseSensitiveMatchField
• linkOpportunitiesCaseSensitiveSourceField: boolean
  Title: linkOpportunitiesCaseSensitiveSourceField
• linkOpportunitiesEntityType: string
  Title: linkOpportunitiesEntityType
• linkOpportunitiesMatchFieldName: string
  Title: linkOpportunitiesMatchFieldName
• linkOpportunitiesMultipleSourceMatches: boolean
  Title: linkOpportunitiesMultipleSourceMatches
• linkOpportunitiesSourceField: string
  Title: linkOpportunitiesSourceField
• name: string
  Title: name
• nullIdentifierFieldName: boolean
  Title: nullIdentifierFieldName
• updatedAt: string(date-time)
  Title: updatedAt
• updatedBy: string
  Title: updatedBy
• updateRule: string
  Title: RuleType

  Default Value: always

  Allowed Values: [ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ]
• updateRuleByField: object updateRuleByField
  Title: updateRuleByField
• uri: string
  Title: uri

{
    "title":"OpportunityContactLinkageImportIndividual",
    "description":"",
    "properties":{
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"",
            "type":"string"
        },
        "externalSystemId":{
            "title":"externalSystemId",
            "description":"",
            "type":"integer"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"object"
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"",
            "type":"string"
        },
        "importPriorityUri":{
            "title":"importPriorityUri",
            "description":"",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"",
            "type":"boolean"
        },
        "isUpdatingMultipleMatchedRecords":{
            "title":"isUpdatingMultipleMatchedRecords",
            "description":"",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"",
            "type":"integer"
        },
        "linkOpportunitiesCaseSensitiveMatchField":{
            "title":"linkOpportunitiesCaseSensitiveMatchField",
            "description":"",
            "type":"boolean"
        },
        "linkOpportunitiesCaseSensitiveSourceField":{
            "title":"linkOpportunitiesCaseSensitiveSourceField",
            "description":"",
            "type":"boolean"
        },
        "linkOpportunitiesEntityType":{
            "title":"linkOpportunitiesEntityType",
            "description":"",
            "type":"string"
        },
        "linkOpportunitiesMatchFieldName":{
            "title":"linkOpportunitiesMatchFieldName",
            "description":"",
            "type":"string"
        },
        "linkOpportunitiesMultipleSourceMatches":{
            "title":"linkOpportunitiesMultipleSourceMatches",
            "description":"",
            "type":"boolean"
        },
        "linkOpportunitiesSourceField":{
            "title":"linkOpportunitiesSourceField",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "nullIdentifierFieldName":{
            "title":"nullIdentifierFieldName",
            "description":"",
            "type":"boolean"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "updateRule":{
            "$ref":"#/definitions/RuleType"
        },
        "updateRuleByField":{
            "title":"updateRuleByField",
            "description":"",
            "type":"object"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: object

Title: fields

Nested Schema : updateRuleByField

Type: object

Title: updateRuleByField

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : OpportunityContactLinkageImportIndividualResponse

Type: object

Title: OpportunityContactLinkageImportIndividualResponse

Show Source

• autoDeleteDuration: string
  Title: autoDeleteDuration
• createdAt: string(date-time)
  Title: createdAt
• createdBy: string
  Title: createdBy
• dataRetentionDuration: string
  Title: dataRetentionDuration
• externalSystemId: integer
  Title: externalSystemId
• fields: object fields
  Title: fields
• identifierFieldName: string
  Title: identifierFieldName
• importPriorityUri: string
  Title: importPriorityUri
• isSyncTriggeredOnImport: boolean
  Title: isSyncTriggeredOnImport
• isUpdatingMultipleMatchedRecords: boolean
  Title: isUpdatingMultipleMatchedRecords
• kbUsed: integer(int64)
  Title: kbUsed
• linkOpportunitiesCaseSensitiveMatchField: boolean
  Title: linkOpportunitiesCaseSensitiveMatchField
• linkOpportunitiesCaseSensitiveSourceField: boolean
  Title: linkOpportunitiesCaseSensitiveSourceField
• linkOpportunitiesEntityType: string
  Title: linkOpportunitiesEntityType
• linkOpportunitiesMatchFieldName: string
  Title: linkOpportunitiesMatchFieldName
• linkOpportunitiesMultipleSourceMatches: boolean
  Title: linkOpportunitiesMultipleSourceMatches
• linkOpportunitiesSourceField: string
  Title: linkOpportunitiesSourceField
• name: string
  Title: name
• nullIdentifierFieldName: boolean
  Title: nullIdentifierFieldName
• updatedAt: string(date-time)
  Title: updatedAt
• updatedBy: string
  Title: updatedBy
• updateRule: string
  Title: RuleType

  Default Value: always

  Allowed Values: [ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ]
• updateRuleByField: object updateRuleByField
  Title: updateRuleByField
• uri: string
  Title: uri

{
    "title":"OpportunityContactLinkageImportIndividualResponse",
    "description":"",
    "properties":{
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"",
            "type":"string"
        },
        "externalSystemId":{
            "title":"externalSystemId",
            "description":"",
            "type":"integer"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"object"
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"",
            "type":"string"
        },
        "importPriorityUri":{
            "title":"importPriorityUri",
            "description":"",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"",
            "type":"boolean"
        },
        "isUpdatingMultipleMatchedRecords":{
            "title":"isUpdatingMultipleMatchedRecords",
            "description":"",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"",
            "type":"integer"
        },
        "linkOpportunitiesCaseSensitiveMatchField":{
            "title":"linkOpportunitiesCaseSensitiveMatchField",
            "description":"",
            "type":"boolean"
        },
        "linkOpportunitiesCaseSensitiveSourceField":{
            "title":"linkOpportunitiesCaseSensitiveSourceField",
            "description":"",
            "type":"boolean"
        },
        "linkOpportunitiesEntityType":{
            "title":"linkOpportunitiesEntityType",
            "description":"",
            "type":"string"
        },
        "linkOpportunitiesMatchFieldName":{
            "title":"linkOpportunitiesMatchFieldName",
            "description":"",
            "type":"string"
        },
        "linkOpportunitiesMultipleSourceMatches":{
            "title":"linkOpportunitiesMultipleSourceMatches",
            "description":"",
            "type":"boolean"
        },
        "linkOpportunitiesSourceField":{
            "title":"linkOpportunitiesSourceField",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "nullIdentifierFieldName":{
            "title":"nullIdentifierFieldName",
            "description":"",
            "type":"boolean"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "updateRule":{
            "$ref":"#/definitions/RuleType"
        },
        "updateRuleByField":{
            "title":"updateRuleByField",
            "description":"",
            "type":"object"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: object

Title: fields

Nested Schema : updateRuleByField

Type: object

Title: updateRuleByField

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 opportunity contact linkage import definition using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Update the opportunity contact linkage import definition with Id#22:

PUT /opportunities/contacts/imports/22
Content-Type: application/json 
			

Request body:

{
  "name": "Opportunity Contact Linkage Import Update",
  "fields": {
    "EmailAddress": "{{Opportunity.Contact.Field(C_EmailAddress)}}",
    "OpportunityID": "{{Opportunity.Id}}"
  },
  "linkOpportunitiesCaseSensitiveMatchField": false,
  "linkOpportunitiesCaseSensitiveSourceField": false,
  "linkOpportunitiesEntityType": "Contact",
  "linkOpportunitiesMatchFieldName": "OpportunityID",
  "linkOpportunitiesMultipleSourceMatches": true,
  "linkOpportunitiesSourceField": "EmailAddress"
}
			

Note:

The request body must:

• Contain the {{Opportunity.Id}} field in the fields.
• Contain one Contact field or one Account field in the fields.
• Contain 2 fields maximum.

Response:

{
  "linkOpportunitiesMatchFieldName": "OpportunityID",
  "linkOpportunitiesSourceField": "EmailAddress",
  "linkOpportunitiesEntityType": "Contact",
  "linkOpportunitiesCaseSensitiveSourceField": false,
  "linkOpportunitiesCaseSensitiveMatchField": false,
  "linkOpportunitiesMultipleSourceMatches": true,
  "name": "Opportunity Contact Linkage Import Update",
  "fields": {
    "EmailAddress": "{{Opportunity.Contact.Field(C_EmailAddress)}}",
    "OpportunityID": "{{Opportunity.Id}}"
  },
  "identifierFieldName": "OpportunityID",
  "syncActions": [],
  "isSyncTriggeredOnImport": false,
  "dataRetentionDuration": "P7D",
  "uri": "/opportunities/contacts/imports/23",
  "createdBy": "API.User",
  "createdAt": "2018-02-15T15:03:43.3330000Z",
  "updatedBy": "API.User",
  "updatedAt": "2018-02-15T15:14:54.0628616Z"
}
			

Note:

identifierFieldName is a read only field set to the linkOpportunitiesMatchFieldName value.

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":"Opportunity Contact Linkage Import Update","fields":{"OpportunityID":"{{Opportunity.Id}}","EmailAddress":"{{Opportunity.Contact.Field(C_EmailAddress)}}"},"identifierFieldName":"OpportunityID","linkOpportunitiesCaseSensitiveMatchField":"true","linkOpportunitiesCaseSensitiveSourceField":"true","linkOpportunitiesEntityType":"Contact","linkOpportunitiesMatchFieldName":"OpportunityID","linkOpportunitiesMultipleSourceMatches":"true","linkOpportunitiesSourceField":"OpportunityID"}' https://secure.p03.eloqua.com/api/bulk/2.0/opportunities/contacts/imports/22
			

Back to Top