This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Working with Contacts in Eloqua

Owned by Former user (Deleted)
Last updated: Mar 30, 2015
12 min read

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
createContactExportCreates a new contact export definition.
createContactImportCreates a new contact import definition.
createContactImportDataSubmits the data for the contact import with the specified id.
updateContactExportUpdates the contact export definition with the specified id.
updateContactImportUpdates the contact import definition with the specified id.
getContactFieldsRetrieve all the details of contact fields.
getContactFieldByIdRetrieve the details of given contact field id.
getContactFiltersRetrieve all the details of contact filters.
getContactFilterByIdRetrieve the details of given contact filter id.
getContactImportsRetrieve all the details of contact imports.
getContactImportByIdRetrieve the details of given contact import id.
getContactExportsRetrieve all the details of contact exports.
getContactExportByIdRetrieve the details of given contact export id.
getContactListsRetrieve all the details of contact lists.
getContactListByIdRetrieve the details of given contact list id.
getContactSegmentsRetrieve all the details of contact segments.
getContactSegmentByIdRetrieve the details of given contact segment id.
getContactExportDataByIdRetrieve the data of given contact export id.
deleteContactExportDeletes the specified contacts export definition.
deleteContactExportDataDeletes 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.

Create Contact Export

The createContactExport operation creates a new contact export definition.

createContactExport
<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.

Sample 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

Create Contact Import

The createContactImport operation creates a new contact import definition.

createContactImport
<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.

Sample 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

Create Contact Import Data

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

createContactImportData
<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.

Sample 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

Update Contact Export

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

updateContactExport
<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.

Sample 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

Update Contact Import

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

updateContactImport
<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.

Sample 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

Get Contact Fields

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

getContactFields
<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.

Sample 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

Get Contact Field By Id

The getContactFieldById operation retrieves the specified field.

getContactFieldById
<eloqua.getContactFieldById>
	<fieldId>{$ctx:fieldId}</fieldId>
</eloqua.getContactFieldById>
properties

  • fieldId: The id of the contact field.

Sample Request

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

Sample 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

Get Contact Filters

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

getContactFilters
<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.

Sample 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

Get Contact Filter By Id

The getContactFilterById operation retrieves the specified filter.

getContactFilterById
<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.

Sample 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

Get Contact Imports

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

getContactImports
<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.

Sample 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

Get Contact Import By Id

The getContactImportById operation retrieves the specified import.

getContactImportById
<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.

Sample 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

Get Contact Exports

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

getContactExports
<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.

Sample 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

Get Contact Export By Id

The getContactExportById operation retrieves the specified export.

getContactExportById
<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.

Sample 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

Get Contact Lists

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

getContactLists
<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.

Sample 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

Get Contact List By Id

The getContactListById operation retrieves the specified list.

getContactListById
<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.

Sample 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

Get Contact Segments

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

getContactSegments
<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.

Sample 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

Get Contact Segment By Id

The getContactSegmentById operation retrieves the specified segment.

getContactSegmentById
<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.

Sample 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

Get Contact Export Data By Id

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

getContactExportDataById
<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.

Sample 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

Delete Contact Export

The deleteContactExport operation deletes the specified export.

deleteContactExport
<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.

Sample 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

Delete Contact Export Data

The deleteContactExportData operation deletes the specified export data.

deleteContactExportData
<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.

Sample 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

Delete Contact Import

The deleteContactImport operation deletes the specified import.

deleteContactImport
<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.

Sample 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

Delete Contact Import Data

The deleteContactImportData operation deletes the specified import data.

deleteContactImportData
<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.

Sample 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

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.

Sample proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="getContactFieldById"
       transports="https http"
       startOnLoad="true"
       trace="disable">
   <description/>
   <target>
      <inSequence>
         <property name="refreshToken" expression="json-eval($.refreshToken)"/>
         <property name="scope" expression="json-eval($.scope)"/>
         <property name="redirectUri" expression="json-eval($.redirectUri)"/>
         <property name="clientId" expression="json-eval($.clientId)"/>
         <property name="apiVersion" expression="json-eval($.apiVersion)"/>
         <property name="clientSecret" expression="json-eval($.clientSecret)"/>
         <property name="fieldId" expression="json-eval($.fieldId)"/>
         <eloqua.getAccessTokenFromRefreshToken>
            <refreshToken>{$ctx:refreshToken}</refreshToken>
            <scope>{$ctx:scope}</scope>
            <redirectUri>{$ctx:redirectUri}</redirectUri>
            <clientId>{$ctx:clientId}</clientId>
            <clientSecret>{$ctx:clientSecret}</clientSecret>
            <apiVersion>{$ctx:apiVersion}</apiVersion>
         </eloqua.getAccessTokenFromRefreshToken>
         <eloqua.getContactFieldById>
            <fieldId>{$ctx:fieldId}</fieldId>
         </eloqua.getContactFieldById>
         <respond/>
      </inSequence>
      <outSequence/>
      <faultSequence/>
   </target>
</proxy>