Jump to

• Request
• Response
• Examples

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

• application/json
• text/csv

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

• autoDeleteDuration: string
  Title: autoDeleteDuration

  Time until the definition will be deleted, expressed using the ISO-8601 standard.
• createdAt: 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: string
  Title: createdBy

  The login id of the user who created the entity. This is a read-only property.
• dataRetentionDuration: 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.
• externalSystemId: integer
  Title: externalSystemId

  The id of the external system.
• fields: object fields
  Title: fields

  List of fields to be included in the operation.
• identifierFieldName: 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: string
  Title: importPriorityUri

  Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
• isSyncTriggeredOnImport: boolean
  Title: isSyncTriggeredOnImport

  Whether or not the sync is triggered on import.
• isUpdatingMultipleMatchedRecords: boolean
  Title: isUpdatingMultipleMatchedRecords

  Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).
• kbUsed: integer(int64)
  Title: kbUsed

  The amount of space used in kilobytes. This is a read-only property.
• linkOpportunitiesCaseSensitiveMatchField: boolean
  Title: linkOpportunitiesCaseSensitiveMatchField

  Whether or not to perform a case sensitive search on the match field.
• linkOpportunitiesCaseSensitiveSourceField: boolean
  Title: linkOpportunitiesCaseSensitiveSourceField

  Whether or not to perform a case sensitive search on the source field.
• linkOpportunitiesEntityType: string
  Title: linkOpportunitiesEntityType

  Specifies the entity of the contact linkage import. Allowed values are "Contact" or "Account".
• linkOpportunitiesMatchFieldName: string
  Title: linkOpportunitiesMatchFieldName

  Specifies the field name for matching.
• linkOpportunitiesMultipleSourceMatches: boolean
  Title: linkOpportunitiesMultipleSourceMatches

  Whether or not imported data will be mapped to multiple matching records.
• linkOpportunitiesSourceField: string
  Title: linkOpportunitiesSourceField

  Specifies the source field name for matching.
• name: string
  Title: name

  The name of the import definition.
• nullIdentifierFieldName: boolean
  Title: nullIdentifierFieldName

  Whether or not to null the identifier field.
• updatedAt: 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: string
  Title: updatedBy

  The login id of the user that last updated the entity. This is a read-only property.
• updateRule: 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.
• updateRuleByField: object updateRuleByField
  Title: updateRuleByField

  The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"OpportunityContactLinkageImportIndividual",
    "description":"The request body defines details of the opportunity contact linkage import definition.",
    "properties":{
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the entity. This is a read-only property.",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"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.",
            "type":"string"
        },
        "externalSystemId":{
            "title":"externalSystemId",
            "description":"The id of the external system.",
            "type":"integer"
        },
        "fields":{
            "title":"fields",
            "description":"List of fields to be included in the operation.",
            "type":"object"
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"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.",
            "type":"string"
        },
        "importPriorityUri":{
            "title":"importPriorityUri",
            "description":"Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"Whether or not the sync is triggered on import.",
            "type":"boolean"
        },
        "isUpdatingMultipleMatchedRecords":{
            "title":"isUpdatingMultipleMatchedRecords",
            "description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to false to update <code>Contact.Field(C_EmailAddress)</code>.",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"The amount of space used in kilobytes. This is a read-only property.",
            "type":"integer"
        },
        "linkOpportunitiesCaseSensitiveMatchField":{
            "title":"linkOpportunitiesCaseSensitiveMatchField",
            "description":"Whether or not to perform a case sensitive search on the match field.",
            "type":"boolean"
        },
        "linkOpportunitiesCaseSensitiveSourceField":{
            "title":"linkOpportunitiesCaseSensitiveSourceField",
            "description":"Whether or not to perform a case sensitive search on the source field.",
            "type":"boolean"
        },
        "linkOpportunitiesEntityType":{
            "title":"linkOpportunitiesEntityType",
            "description":"Specifies the entity of the contact linkage import. Allowed values are \"Contact\" or \"Account\".",
            "type":"string"
        },
        "linkOpportunitiesMatchFieldName":{
            "title":"linkOpportunitiesMatchFieldName",
            "description":"Specifies the field name for matching.",
            "type":"string"
        },
        "linkOpportunitiesMultipleSourceMatches":{
            "title":"linkOpportunitiesMultipleSourceMatches",
            "description":"Whether or not imported data will be mapped to multiple matching records.",
            "type":"boolean"
        },
        "linkOpportunitiesSourceField":{
            "title":"linkOpportunitiesSourceField",
            "description":"Specifies the source field name for matching.",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"The name of the import definition.",
            "type":"string"
        },
        "nullIdentifierFieldName":{
            "title":"nullIdentifierFieldName",
            "description":"Whether or not to null the identifier field.",
            "type":"boolean"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"The login id of the user that last updated the entity. This is a read-only property.",
            "type":"string"
        },
        "updateRule":{
            "$ref":"#/definitions/RuleType"
        },
        "updateRuleByField":{
            "title":"updateRuleByField",
            "description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
            "type":"object"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: object

Title: fields

List of fields to be included in the operation.

Nested Schema : updateRuleByField

Type: object

Title: updateRuleByField

The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.

Back to Top

Response

Supported Media Types

• application/json

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

• autoDeleteDuration: string
  Title: autoDeleteDuration

  Time until the definition will be deleted, expressed using the ISO-8601 standard.
• createdAt: 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: string
  Title: createdBy

  The login id of the user who created the entity. This is a read-only property.
• dataRetentionDuration: 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.
• externalSystemId: integer
  Title: externalSystemId

  The id of the external system.
• fields: object fields
  Title: fields

  List of fields to be included in the operation.
• identifierFieldName: 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: string
  Title: importPriorityUri

  Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
• isSyncTriggeredOnImport: boolean
  Title: isSyncTriggeredOnImport

  Whether or not the sync is triggered on import.
• isUpdatingMultipleMatchedRecords: boolean
  Title: isUpdatingMultipleMatchedRecords

  Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).
• kbUsed: integer(int64)
  Title: kbUsed

  The amount of space used in kilobytes. This is a read-only property.
• linkOpportunitiesCaseSensitiveMatchField: boolean
  Title: linkOpportunitiesCaseSensitiveMatchField

  Whether or not to perform a case sensitive search on the match field.
• linkOpportunitiesCaseSensitiveSourceField: boolean
  Title: linkOpportunitiesCaseSensitiveSourceField

  Whether or not to perform a case sensitive search on the source field.
• linkOpportunitiesEntityType: string
  Title: linkOpportunitiesEntityType

  Specifies the entity of the contact linkage import. Allowed values are "Contact" or "Account".
• linkOpportunitiesMatchFieldName: string
  Title: linkOpportunitiesMatchFieldName

  Specifies the field name for matching.
• linkOpportunitiesMultipleSourceMatches: boolean
  Title: linkOpportunitiesMultipleSourceMatches

  Whether or not imported data will be mapped to multiple matching records.
• linkOpportunitiesSourceField: string
  Title: linkOpportunitiesSourceField

  Specifies the source field name for matching.
• name: string
  Title: name

  The name of the import definition.
• nullIdentifierFieldName: boolean
  Title: nullIdentifierFieldName

  Whether or not to null the identifier field.
• updatedAt: 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: string
  Title: updatedBy

  The login id of the user that last updated the entity. This is a read-only property.
• updateRule: 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.
• updateRuleByField: object updateRuleByField
  Title: updateRuleByField

  The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"OpportunityContactLinkageImportIndividualResponse",
    "description":"The response body includes information about the opportunity contact linkage import definition.",
    "properties":{
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the entity. This is a read-only property.",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"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.",
            "type":"string"
        },
        "externalSystemId":{
            "title":"externalSystemId",
            "description":"The id of the external system.",
            "type":"integer"
        },
        "fields":{
            "title":"fields",
            "description":"List of fields to be included in the operation.",
            "type":"object"
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"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.",
            "type":"string"
        },
        "importPriorityUri":{
            "title":"importPriorityUri",
            "description":"Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"Whether or not the sync is triggered on import.",
            "type":"boolean"
        },
        "isUpdatingMultipleMatchedRecords":{
            "title":"isUpdatingMultipleMatchedRecords",
            "description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to false to update <code>Contact.Field(C_EmailAddress)</code>.",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"The amount of space used in kilobytes. This is a read-only property.",
            "type":"integer"
        },
        "linkOpportunitiesCaseSensitiveMatchField":{
            "title":"linkOpportunitiesCaseSensitiveMatchField",
            "description":"Whether or not to perform a case sensitive search on the match field.",
            "type":"boolean"
        },
        "linkOpportunitiesCaseSensitiveSourceField":{
            "title":"linkOpportunitiesCaseSensitiveSourceField",
            "description":"Whether or not to perform a case sensitive search on the source field.",
            "type":"boolean"
        },
        "linkOpportunitiesEntityType":{
            "title":"linkOpportunitiesEntityType",
            "description":"Specifies the entity of the contact linkage import. Allowed values are \"Contact\" or \"Account\".",
            "type":"string"
        },
        "linkOpportunitiesMatchFieldName":{
            "title":"linkOpportunitiesMatchFieldName",
            "description":"Specifies the field name for matching.",
            "type":"string"
        },
        "linkOpportunitiesMultipleSourceMatches":{
            "title":"linkOpportunitiesMultipleSourceMatches",
            "description":"Whether or not imported data will be mapped to multiple matching records.",
            "type":"boolean"
        },
        "linkOpportunitiesSourceField":{
            "title":"linkOpportunitiesSourceField",
            "description":"Specifies the source field name for matching.",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"The name of the import definition.",
            "type":"string"
        },
        "nullIdentifierFieldName":{
            "title":"nullIdentifierFieldName",
            "description":"Whether or not to null the identifier field.",
            "type":"boolean"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"The login id of the user that last updated the entity. This is a read-only property.",
            "type":"string"
        },
        "updateRule":{
            "$ref":"#/definitions/RuleType"
        },
        "updateRuleByField":{
            "title":"updateRuleByField",
            "description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
            "type":"object"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: object

Title: fields

List of fields to be included in the operation.

Nested Schema : updateRuleByField

Type: object

Title: updateRuleByField

The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.

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