Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3
typeflat

...

Overview

The following operations allow you to work with contacts. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with contacts, see Sample configuration .

OperationDescription
1Working with Contacts in EloquacreateContactExportCreates a new contact export definition.
1Working with Contacts in EloquacreateContactImportCreates a new contact import definition.
1Working with Contacts in EloquacreateContactImportDataSubmits the data for the contact import with the specified id.
updateContactExportUpdates the contact export definition with the specified id.
1Working with Contacts in EloquaupdateContactImportUpdates the contact import definition with the specified id.
1Working with Contacts in EloquagetContactFieldsRetrieve all the details of contact fields.
getContactFieldByIdRetrieve the details of given contact field id.
1Working with Contacts in EloquagetContactFiltersRetrieve all the details of contact filters.
1Working with Contacts in EloquagetContactFilterByIdRetrieve the details of given contact filter id.
getContactImportsRetrieve all the details of contact imports.
1Working with Contacts in EloquagetContactImportByIdRetrieve the details of given contact import id.
1Working with Contacts in EloquagetContactExportsRetrieve all the details of contact exports.
1Working with Contacts in EloquagetContactExportByIdRetrieve the details of given contact export id.
1Working with Contacts in EloquagetContactListsRetrieve all the details of contact lists.
1Working with Contacts in EloquagetContactListByIdRetrieve the details of given contact list id.
1Working with Contacts in EloquagetContactSegmentsRetrieve all the details of contact segments.
1Working with Contacts in EloquagetContactSegmentByIdRetrieve the details of given contact segment id.
1Working with Contacts in EloquagetContactExportDataByIdRetrieve the data of given contact export id.
1Working with Contacts in EloquadeleteContactExportDeletes the specified contacts export definition.
1Working with Contacts in EloquadeleteContactExportDataDeletes the data for the contact export with the specified id.
deleteContactImportDeletes the specified contact import definition.
deleteContactImportDataDeletes the data for the contact import with the specified id.

Operation Details

This section provides further details on the operations related to contacts.

Anchor
createContactExport
createContactExport
Create Contact Export

The createContactExport operation creates a new contact export definition.

Code Block
languagexml
titlecreateContactExport
<eloqua.createContactExport>
    <name>{$ctx:name}</name>
    <fields>{$ctx:fields}</fields>
    <autoDeleteDuration>{$ctx:autoDeleteDuration}</autoDeleteDuration>
    <filter>{$ctx:filter}</filter>
    <createdAt>{$ctx:createdAt}</createdAt>
    <createdBy>{$ctx:createdBy}</createdBy>
    <dataRetentionDuration>{$ctx:dataRetentionDuration}</dataRetentionDuration>
    <kbUsed>{$ctx:kbUsed}</kbUsed>
    <maxRecords>{$ctx:maxRecords}</maxRecords>
    <syncActions>{$ctx:syncActions}</syncActions>
    <updatedAt>{$ctx:updatedAt}</updatedAt>
    <updatedBy>{$ctx:updatedBy}</updatedBy>
	<uri>{$ctx:uri}</uri>
</eloqua.createContactExport>
properties

  • name: Name of the definition. Useful for reusing definitions.

  • fields : List of fields to be included in the operation.

  • autoDeleteDuration : Time until the definition will be deleted.

  • filter : Specifies what data should be included in the export.

  • createdAt: Timestamp when the definition was created.

  • createdBy: User who created the definition.
  • dataRetentionDuration: Time until the staged data will be deleted.
  • kbUsed: The amount of space required to store staged data.
  • maxRecords: Specifies the maximum number of records to export.
  • syncActions: Specifies additional operations to import or export.
  • updatedAt: Timestamp when the definition was updated.
  • updatedBy: User who updated the definition.
  • uri: System- generated URI that defines the definition for future referencing.
Sample request

Following is a sample REST/JSON request that can be handled by the createContactExport operation.

Code Block
languagexml
titleSample request for createContactExport
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "name":"testExport",
	"fields":{"ContactId":"Contact.Id","FirstName":"Contact.Field(C_FirstName)","LastName":"Contact.Field(C_LastName)"},
	"autoDeleteDuration":"100"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/post-exports.htm

Anchor
createContactImport
createContactImport
Create Contact Import

The createContactImport operation creates a new contact import definition.

Code Block
languagexml
titlecreateContactImport
<eloqua.createContactImport>
	<name>{$ctx:name}</name>
    <fields>{$ctx:fields}</fields>
    <autoDeleteDuration>{$ctx:autoDeleteDuration}</autoDeleteDuration>
    <isUpdatingMultipleMatchedRecords>{$ctx:isUpdatingMultipleMatchedRecords}</isUpdatingMultipleMatchedRecords>
    <createdAt>{$ctx:createdAt}</createdAt>
    <createdBy>{$ctx:createdBy}</createdBy>
    <dataRetentionDuration>{$ctx:dataRetentionDuration}</dataRetentionDuration>
    <identifierFieldName>{$ctx:identifierFieldName}</identifierFieldName>
    <kbUsed>{$ctx:kbUsed}</kbUsed>
    <updateRule>{$ctx:updateRule}</updateRule>
    <syncActions>{$ctx:syncActions}</syncActions>
    <updatedAt>{$ctx:updatedAt}</updatedAt>
    <updatedBy>{$ctx:updatedBy}</updatedBy>
    <uri>{$ctx:uri}</uri>
</eloqua.createContactImport>
properties

  • name: Name of the definition. Useful for reusing definitions.

  • fields : List of fields to be included in the operation.

  • autoDeleteDuration : Time until the definition will be deleted.

  • isUpdatingMultipleMatchedRecords : Specifies whether Eloqua should update multiple records if multiple records match the identifierFieldName.

  • createdAt: Timestamp when the definition was created.

  • createdBy: User who created the definition.
  • dataRetentionDuration: Time until the staged data will be deleted.
  • identifierFieldName: Specifies which field to use to match the imported data to existing Eloqua data.
  • updateRule: Specifies how updates should be handled.
  • kbUsed: The amount of space required to store staged data.
  • syncActions: Specifies additional operations to import or export.
  • updatedAt: Timestamp when the definition was updated.
  • updatedBy: User who updated the definition.
  • uri: System- generated URI that defines the definition for future referencing.

Sample request

Following is a sample REST/JSON request that can be handled by the createContactImport operation.

Code Block
languagexml
titleSample request for createContactImport
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "name":"testImport",
	"fields":{"ContactId":"Contact.Id","FirstName":"Contact.Field(C_FirstName)","LastName":"Contact.Field(C_LastName)"},
	"identifierFieldName":"ContactId"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/post-imports.htm

Anchor
createContactImportData
createContactImportData
Create Contact Import Data

The createContactImportData operation submits the data for the contact import with the specified id.

Code Block
languagexml
titlecreateContactImportData
<eloqua.createContactImportData>
    <importId>{$ctx:importId}</importId>
	<importData>{$ctx:importData}</importData>
</eloqua.createContactImportData>
properties

  • importId: The id of the import.

  • importData: Array of dictionary of strings.
Sample Request

Following is a sample REST/JSON request that can be handled by createContactImportData operation.

Code Block
languagexml
titleSample request for createContactImportData
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"importId":"1",
	"importData":[
    {
        "ContactId": "1",
        "FirstName": "Harry"
    },
    {
        "ContactId": "2",
        "FirstName": "Lisanne"
    }
]
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/post-imports-id-data.htm

Anchor
updateContactExport
updateContactExport
Update Contact Export

The updateContactExport operation updates the contact export definition with the specified id.

Code Block
languagexml
titleupdateContactExport
<eloqua.updateContactExport>
	<exportId>{$ctx:exportId}</exportId>
 	<name>{$ctx:name}</name>
    <fields>{$ctx:fields}</fields>
    <autoDeleteDuration>{$ctx:autoDeleteDuration}</autoDeleteDuration>
    <filter>{$ctx:filter}</filter>
    <createdAt>{$ctx:createdAt}</createdAt>
    <createdBy>{$ctx:createdBy}</createdBy>
    <dataRetentionDuration>{$ctx:dataRetentionDuration}</dataRetentionDuration>
    <kbUsed>{$ctx:kbUsed}</kbUsed>
    <maxRecords>{$ctx:maxRecords}</maxRecords>
    <syncActions>{$ctx:syncActions}</syncActions>
    <updatedAt>{$ctx:updatedAt}</updatedAt>
    <updatedBy>{$ctx:updatedBy}</updatedBy>
	<uri>{$ctx:uri}</uri>
</eloqua.updateContactExport>
properties

  • exportId: The id of the export.

  • name: Name of the definition. Useful for reusing definitions.

  • fields : List of fields to be included in the operation.

  • autoDeleteDuration : Time until the definition will be deleted.

  • filter : Specifies what data should be included in the export.

  • createdAt: Timestamp when the definition was created.

  • createdBy: User who created the definition.
  • dataRetentionDuration: Time until the staged data will be deleted.
  • kbUsed: The amount of space required to store staged data.
  • maxRecords: Specifies the maximum number of records to export.
  • syncActions: Specifies additional operations to import or export.
  • updatedAt: Timestamp when the definition was updated.
  • updatedBy: User who updated the definition.
  • uri: System- generated URI that defines the definition for future referencing.
Sample request

Following is a sample REST/JSON request that can be handled by the updateContactExport operation.

Code Block
languagexml
titleSample request for updateContactExport
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"exportId":"34",
    "name":"testExport",
	"fields":{"ContactId":"Contact.Id","FirstName":"Contact.Field(C_FirstName)","LastName":"Contact.Field(C_LastName)"},
	"autoDeleteDuration":"100"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/put-exports-id.htm

Anchor
updateContactImport
updateContactImport
Update Contact Import

The updateContactImport operation updates the contact import definition with the specified id.

Code Block
languagexml
titleupdateContactImport
<eloqua.updateContactImport>
	<importId>{$ctx:importId}</importId>
	<name>{$ctx:name}</name>
    <fields>{$ctx:fields}</fields>
    <autoDeleteDuration>{$ctx:autoDeleteDuration}</autoDeleteDuration>
    <isUpdatingMultipleMatchedRecords>{$ctx:isUpdatingMultipleMatchedRecords}</isUpdatingMultipleMatchedRecords>
    <createdAt>{$ctx:createdAt}</createdAt>
    <createdBy>{$ctx:createdBy}</createdBy>
    <dataRetentionDuration>{$ctx:dataRetentionDuration}</dataRetentionDuration>
    <identifierFieldName>{$ctx:identifierFieldName}</identifierFieldName>
    <kbUsed>{$ctx:kbUsed}</kbUsed>
    <updateRule>{$ctx:updateRule}</updateRule>
    <syncActions>{$ctx:syncActions}</syncActions>
    <updatedAt>{$ctx:updatedAt}</updatedAt>
    <updatedBy>{$ctx:updatedBy}</updatedBy>
    <uri>{$ctx:uri}</uri>
</eloqua.updateContactImport>
properties

  • importId: The id of the import.

  • name: Name of the definition. Useful for reusing definitions.

  • fields : List of fields to be included in the operation.

  • autoDeleteDuration : Time until the definition will be deleted.

  • isUpdatingMultipleMatchedRecords : Specifies whether Eloqua should update multiple records if multiple records match the identifierFieldName.

  • createdAt: Timestamp when the definition was created.

  • createdBy: User who created the definition.
  • dataRetentionDuration: Time until the staged data will be deleted.
  • identifierFieldName: Specifies which field to use to match the imported data to existing Eloqua data.
  • updateRule: Specifies how updates should be handled.
  • kbUsed: The amount of space required to store staged data.
  • syncActions: Specifies additional operations to import or export.
  • updatedAt: Timestamp when the definition was updated.
  • updatedBy: User who updated the definition.
  • uri: System- generated URI that defines the definition for future referencing.
Sample request

Following is a sample REST/JSON request that can be handled by the updateContactImport operation.

Code Block
languagexml
titleSample request for updateContactImport
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"importId":"54",
    "name":"testImport",
	"fields":{"ContactId":"Contact.Id","FirstName":"Contact.Field(C_FirstName)","LastName":"Contact.Field(C_LastName)"},
	"identifierFieldName":"ContactId"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/put-imports-id.htm

Anchor
getContactFields
getContactFields
Get Contact Fields

The getContactFields operation retrieves all contact fields that match the specified criteria.

Code Block
languagexml
titlegetContactFields
<eloqua.getContactFields>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getContactFields>
properties

  • limit: Specifies maximum number of records to return.

  • offset : Specifies an offset that allows to retrieve the next batch of records.

  • orderBy : Term to order the results by..

  • q : Specifies query criteria used to filter resultl.

  • totalResults: The total number of records that satisfy the request.
Sample request

Following is a sample REST/JSON request that can be handled by the getContactFields operation.

Code Block
languagexml
titleSample request for getContactFields
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "totalResults":"true",
    "q":"name='E*'",
    "orderBy":"name DESC",
    "offset":"0",
    "limit":"10"   
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-fields.htm

Anchor
getContactFieldById
getContactFieldById
Get Contact Field By Id

The getContactFieldById operation retrieves the specified field.

Code Block
languagexml
titlegetContactFieldById
<eloqua.getContactFieldById>
	<fieldId>{$ctx:fieldId}</fieldId>
</eloqua.getContactFieldById>
properties

  • fieldId: The id of the contact field.

Anchor
sampleRequest
sampleRequest
Sample Request

Following is a sample REST/JSON request that can be handled by getContactFieldById operation.

Code Block
languagexml
titleSample request for getContactFieldById
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"fieldId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-fields-id.htm

Anchor
getContactFilters
getContactFilters
Get Contact Filters

The getContactFilters operation retrieves all contact filters that match the specified criteria.

Code Block
languagexml
titlegetContactFilters
<eloqua.getContactFilters>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getContactFilters>
properties

  • limit: Specifies maximum number of records to return.

  • offset : Specifies an offset that allows to retrieve the next batch of records.

  • orderBy : Term to order the results by..

  • q : Specifies query criteria used to filter resultl.

  • totalResults: The total number of records that satisfy the request.
Sample request

Following is a sample REST/JSON request that can be handled by the getContactFilters operation.

Code Block
languagexml
titleSample request for getContactFilters
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "totalResults":"true",
    "q":"name='E*'",
    "orderBy":"name DESC",
    "offset":"0",
    "limit":"10"   
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-filters.htm

Anchor
getContactFilterById
getContactFilterById
Get Contact Filter By Id

The getContactFilterById operation retrieves the specified filter.

Code Block
languagexml
titlegetContactFilterById
<eloqua.getContactFieldById>
	<filterId>{$ctx:filterId}</filterId>
</eloqua.getContactFilterById>
properties

  • filterId: The id of the contact filter.

Sample Request

Following is a sample REST/JSON request that can be handled by getContactFilterById operation.

Code Block
languagexml
titleSample request for getContactFilterById
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"filterId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-filters-id.htm

Anchor
getContactImports
getContactImports
Get Contact Imports

The getContactImports operation retrieves all contact imports that match the specified criteria.

Code Block
languagexml
titlegetContactImports
<eloqua.getContactFields>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getContactFields>
properties

  • limit: Specifies maximum number of records to return.

  • offset : Specifies an offset that allows to retrieve the next batch of records.

  • orderBy : Term to order the results by..

  • q : Specifies query criteria used to filter resultl.

  • totalResults: The total number of records that satisfy the request.
Sample request

Following is a sample REST/JSON request that can be handled by the getContactImports operation.

Code Block
languagexml
titleSample request for getContactImports
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "totalResults":"true",
    "q":"name='E*'",
    "orderBy":"name DESC",
    "offset":"0",
    "limit":"10"   
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-imports.htm

Anchor
getContactImportById
getContactImportById
Get Contact Import By Id

The getContactImportById operation retrieves the specified import.

Code Block
languagexml
titlegetContactImportById
<eloqua.getContactImportById>
	<importId>{$ctx:importId}</importId>
</eloqua.getContactImportById>
properties

  • importId: The id of the contact import.

Sample Request

Following is a sample REST/JSON request that can be handled by getContactImportById operation.

Code Block
languagexml
titleSample request for getContactImportById
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"importdId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-imports-id.htm

Anchor
getContactExports
getContactExports
Get Contact Exports

The getContactExports operation retrieves all contact exports that match the specified criteria.

Code Block
languagexml
titlegetContactExports
<eloqua.getContactExports>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getContactExports>
properties

  • limit: Specifies maximum number of records to return.

  • offset : Specifies an offset that allows to retrieve the next batch of records.

  • orderBy : Term to order the results by..

  • q : Specifies query criteria used to filter resultl.

  • totalResults: The total number of records that satisfy the request.
Sample request

Following is a sample REST/JSON request that can be handled by the getContactExports operation.

Code Block
languagexml
titleSample request for getContactExports
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "totalResults":"true",
    "q":"name='E*'",
    "orderBy":"name DESC",
    "offset":"0",
    "limit":"10"   
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-exports.htm

Anchor
getContactExportById
getContactExportById
Get Contact Export By Id

The getContactExportById operation retrieves the specified export.

Code Block
languagexml
titlegetContactExportById
<eloqua.getContactExportById>
	<exportId>{$ctx:exportId}</exportId>
</eloqua.getContactExportById>
properties

  • exportId: The id of the contact export.

Sample Request

Following is a sample REST/JSON request that can be handled by getContactExportById operation.

Code Block
languagexml
titleSample request for getContactExportById
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"exportId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-exports-id.htm

Anchor
getContactLists
getContactLists
Get Contact Lists

The getContactLists operation retrieves all contact lists that match the specified criteria.

Code Block
languagexml
titlegetContactLists
<eloqua.getContactLists>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getContactLists>
properties

  • limit: Specifies maximum number of records to return.

  • offset : Specifies an offset that allows to retrieve the next batch of records.

  • orderBy : Term to order the results by..

  • q : Specifies query criteria used to filter resultl.

  • totalResults: The total number of records that satisfy the request.
Sample request

Following is a sample REST/JSON request that can be handled by the getContactLists operation.

Code Block
languagexml
titleSample request for getContactLists
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "totalResults":"true",
    "q":"name='E*'",
    "orderBy":"name DESC",
    "offset":"0",
    "limit":"10"   
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-lists.htm

Anchor
getContactListById
getContactListById
Get Contact List By Id

The getContactListById operation retrieves the specified list.

Code Block
languagexml
titlegetContactListById
<eloqua.getContactListById>
	<listId>{$ctx:listId}</listId>
</eloqua.getContactListById>
properties

  • listId: The id of the contact list.

Sample Request

Following is a sample REST/JSON request that can be handled by getContactListById operation.

Code Block
languagexml
titleSample request for getContactListById
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"listId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-lists-id.htm

Anchor
getContactSegments
getContactSegments
Get Contact Segments

The getContactSegments operation retrieves all contact segments that match the specified criteria.

Code Block
languagexml
titlegetContactSegments
<eloqua.getContactSegments>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getContactSegments>
properties

  • limit: Specifies maximum number of records to return.

  • offset : Specifies an offset that allows to retrieve the next batch of records.

  • orderBy : Term to order the results by..

  • q : Specifies query criteria used to filter resultl.

  • totalResults: The total number of records that satisfy the request.
Sample request

Following is a sample REST/JSON request that can be handled by the getContactSegments operation.

Code Block
languagexml
titleSample request for getContactSegments
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "totalResults":"true",
    "q":"name='E*'",
    "orderBy":"name DESC",
    "offset":"0",
    "limit":"10"   
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-segments.htm

Anchor
getContactSegmentById
getContactSegmentById
Get Contact Segment By Id

The getContactSegmentById operation retrieves the specified segment.

Code Block
languagexml
titlegetContactSegmentById
<eloqua.getContactSegmentById>
	<segmentId>{$ctx:segmentId}</segmentId>
</eloqua.getContactSegmentById>
properties

  • segmentId: The id of the contact segment.

Sample Request

Following is a sample REST/JSON request that can be handled by getContactSegmentById operation.

Code Block
languagexml
titleSample request for getContactSegmentById
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"segmentId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-segments-id.htm

Anchor
getContactExportDataById
getContactExportDataById
Get Contact Export Data By Id

The getContactExportDataById operation retrieves the data for the specified contact export.

Code Block
languagexml
titlegetContactExportDataById
<eloqua.getContactExportDataById>
    <exportId>{$ctx:exportId}</exportId>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getContactExportDataById>
properties

  • exportId: The id of the contact export.

  • limit: Specifies maximum number of records to return.

  • offset : Specifies an offset that allows to retrieve the next batch of records.

  • totalResults: The total number of records that satisfy the request.
Sample Request

Following is a sample REST/JSON request that can be handled by getContactExportDataById operation.

Code Block
languagexml
titleSample request for getContactExportDataById
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"exportId":"1",
	"totalResults":"true",
	"offset":"2,
	"limit":"1o"
 }
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/get-exports-id-data.htm

Anchor
deleteContactExport
deleteContactExport
Delete Contact Export

The deleteContactExport operation deletes the specified export.

Code Block
languagexml
titledeleteContactExport
<eloqua.deleteContactExport>
	<exportId>{$ctx:exportId}</exportId>
</eloqua.deleteContactExport>
properties

  • exportId: The id of the contact export.

Sample Request

Following is a sample REST/JSON request that can be handled by deleteContactExport operation.

Code Block
languagexml
titleSample request for deleteContactExport
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"exportId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/delete-exports-id.htm

Anchor
deleteContactExportData
deleteContactExportData
Delete Contact Export Data

The deleteContactExportData operation deletes the specified export data.

Code Block
languagexml
titledeleteContactExportData
<eloqua.deleteContactExportData>
	<exportId>{$ctx:exportId}</exportId>
</eloqua.deleteContactExportData>
properties

  • exportId: The id of the contact export.

Sample Request

Following is a sample REST/JSON request that can be handled by deleteContactExportData operation.

Code Block
languagexml
titleSample request for deleteContactExportData
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"exportId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/delete-exports-id-data.htm

Anchor
deleteContactImport
deleteContactImport
Delete Contact Import

The deleteContactImport operation deletes the specified import.

Code Block
languagexml
titledeleteContactImport
<eloqua.deleteContactImport>
	<importId>{$ctx:importId}</importId>
</eloqua.deleteContactImport>
properties

  • importId: The id of the contact import.

Sample Request

Following is a sample REST/JSON request that can be handled by deleteContactImport operation.

Code Block
languagexml
titleSample request for deleteContactImport
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"exportId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/delete-imports-id.htm

Anchor
deleteContactImportData
deleteContactImportData
Delete Contact Import Data

The deleteContactImportData operation deletes the specified import data.

Code Block
languagexml
titledeleteContactImportData
<eloqua.deleteContactImportData>
	<importId>{$ctx:importId}</importId>
</eloqua.deleteContactImportData>
properties

  • importId: The id of the contact import.

Sample Request

Following is a sample REST/JSON request that can be handled by deleteContactImportData operation.

Code Block
languagexml
titleSample request for deleteContactImportData
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"importId":"100001"
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/contacts/delete-imports-id-data.htm

Anchor
sampleProxy
sampleProxy
Sample Configuration

Following is a sample proxy service that illustrates how to connect to Eloqua with the getAccessTokenFromRefreshToken operation and use the getContactFieldById operation. The sample request for this proxy can be found in  getContactFieldById sample request  . You can use this sample as a template for using other operations in this category.

...