Create an opportunity contact linkage import definition

post

/api/bulk/2.0/opportunities/contacts/imports

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

Request

Supported Media Types
Body ()
The request body contains details of the opportunity contact linkage import definition.
Root Schema : OpportunityContactLinkageImportIndividual
Type: object
Title: OpportunityContactLinkageImportIndividual
The request body defines details of the opportunity contact linkage import definition.
Show Source
Nested Schema : fields
Type: array
Title: fields
List of fields to be included in the operation.
Show Source
Back to Top

Response

Supported Media Types

201 Response

OK.
Body ()
Root Schema : OpportunityContactLinkageImportIndividualResponse
Type: object
Title: OpportunityContactLinkageImportIndividualResponse
The response body includes information about the opportunity contact linkage import definition.
Show Source
Nested Schema : fields
Type: array
Title: fields
List of fields to be included in the operation.
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 opportunity contact linkage import definition using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Create a new opportunity contact linkage import definition:


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

Request body:


{
  "name": "Opportunity Contact Linkage Import",
  "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 a maximum of 2 fields.

Response:


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

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