Working with Contact Lists

Overview

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

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

For more details click Contact Lists.

Operation	Description
createAContactList	Creates a new contact list.
updateAContactList	Updates a contact list.
getAllContactLists	Retrieves all contact lists.
getAContactList	Retrieves the details of a contact list associated with the contact list id.
deleteAContactList	Deletes a contact list associated with the specified contact list id.

Operation Details

This section provides further details on the operations related to Contact Lists.

Create A Contact List

The createAContactList operation creates a new contact list.

createAContactList

<eloquaStandardAPI.createAContactList>
    <scope>global</scope>
    <count>10</count>
    <membershipAdditions>["1"]</membershipAdditions>
    <name>my new contact list</name>
    <dataLookupId>3965b95a-9e64-42bf-9d8d-a277bf02184f</dataLookupId>
    <membershipDeletions>["1"]</membershipDeletions>
</eloquaStandardAPI.createAContactList>

properties

scope : To create a contact list on this scope.
count : The number of the contacts on a list.
membershipAdditions : Boolean value, to set the permission to add members.
name : Name of the contact list to create the list on this name.
dataLookupId : The identifier of data lookup.
membershipDeletions : Boolean value, to set the permission to delete members.

Sample request

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

Sample request for createAContactList

{
   "username":"myusername",
   "password":"mypassword",
   "siteName":"mysiteName",
   "scope":"global",
   "count":10,
   "membershipAdditions":["1"],
   "name":"my new contact list",
   "dataLookupId":"3965b95a-9e64-42bf-9d8d-a277bf02184f",
   "membershipDeletions":["1"]
}

Update A Contact List

The updateAContactList operation updates a contact list.

updateAContactList

<eloquaStandardAPI.updateAContactList>
    <scope>global</scope>
    <count>10</count>
    <membershipAdditions>["1"]</membershipAdditions>
    <name>my new contact list</name>
    <dataLookupId>3965b95a-9e64-42bf-9d8d-a277bf02184f</dataLookupId>
    <membershipDeletions>["1"]</membershipDeletions>
</eloquaStandardAPI.updateAContactList>

properties

contactListId : Unique identifier of the contact list.
scope : To create a contact list on this scope.
count : The number of the contacts on a list.
membershipAdditions : Boolean value, to set the permission to add members.
name : Name of the contact list to update the list on this name.
dataLookupId : The identifier of data lookup.
membershipDeletions : Boolean value, to set the permission to delete members.

Sample request

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

Sample request for updateAContactList

{   
   "username":"myusername",
   "password":"mypassword",
   "siteName":"mysiteName",
   "contactListId":"1",
   "scope":"global",
   "count":10,
   "membershipAdditions":["1"],
   "name":"my new contact list",
   "dataLookupId":"3965b95a-9e64-42bf-9d8d-a277bf02184f",
   "membershipDeletions":["1"]
}

Get All Contact Lists

The getAllContactLists operation retrieves all contact lists.

getAllContactLists

<eloquaStandardAPI.getAllContactLists>
    <count>2</count>
    <depth>1</depth>
    <search></search>
    <page>1</page>
    <orderBy></orderBy>
    <lastUpdatedAt>1426066807</lastUpdatedAt>
    <extensions>1</extensions>
</eloquaStandardAPI.getAllContactLists>

properties

count : The number of results in a page to display. This must me in between 1 and 1000.
depth :The RequestDepth. It can be 'Complete' or 'Reference' or 'Minimal' or 'Partial'.
search :The search field, to search for that field.
page :The page number to display. This must be greater than 1.
orderBy :The order by property to order the fields.
lastUpdatedAt :The date time of the last update.
extensions :The identifier of the view.

Sample Request

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

Sample request for getAllContactLists

{   
   "username":"myusername",
   "password":"mypassword",
   "siteName":"mysiteName",
   "count":2,
   "page":1,
   "lastUpdatedAt":1426066807,
   "depth":"Complete",
   "extensions":"1"
}

Get A Contact List

The getAContactList operation retrieves the details of a contact list associated with the specified contact list id.

getAContactList

<eloquaStandardAPI.getAContactList>
	<contactListId>1</contactListId>
	<depth>Complete</depth>
	<extensions></extensions>
</eloquaStandardAPI.getAContactList>

properties

contactListId : Unique identifier of the contact list.
depth :The RequestDepth. It can be 'Complete' or 'Reference' or 'Minimal' or 'Partial'.
extensions :The identifier of the view.

Sample request

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

Sample request for getAContactList

{   
   "username":"myusername",
   "password":"mypassword",
   "siteName":"mysiteName",
   "contactListId":"1",
   "depth":"Complete"
}

Delete A Contact List

The deleteAContactList operation deletes a contact list information associated with the specified contact list id.

deleteAContactList

<eloquaStandardAPI.deleteAContactList>
	<contactListId>1</contactListId>
</eloquaStandardAPI.deleteAContactList>

properties

contactListId :Unique identifier of the contact list.

Sample request

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

Sample request for deleteAContactList

{  
   "username":"myusername",
   "password":"mypassword",
   "siteName":"mysiteName",
   "contactListId":"1"
}

Sample Configuration

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

Sample proxy

<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="eloqua_getAllContactLists"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
    <target>
        <inSequence>
            <property name="siteName" expression="json-eval($.siteName)"/>
            <property name="username" expression="json-eval($.username)"/>
            <property name="password" expression="json-eval($.password)"/>
            <property name="count" expression="json-eval($.count)"/>
            <property name="depth" expression="json-eval($.depth)"/>
            <property name="search" expression="json-eval($.search)"/>
            <property name="page" expression="json-eval($.page)"/>
            <property name="orderBy" expression="json-eval($.orderBy)"/>
            <property name="lastUpdatedAt" expression="json-eval($.lastUpdatedAt)"/>
            <property name="extensions" expression="json-eval($.extensions)"/>
            <eloquaStandardAPI.init>
                <siteName>{$ctx:siteName}</siteName>
                <username>{$ctx:username}</username>
                <password>{$ctx:password}</password>
            </eloquaStandardAPI.init>
            <eloquaStandardAPI.getAllContactLists>
                <count>{$ctx:count}</count>
                <depth>{$ctx:depth}</depth>
                <search>{$ctx:search}</search>
                <page>{$ctx:page}</page>
                <orderBy>{$ctx:orderBy}</orderBy>
                <lastUpdatedAt>{$ctx:lastUpdatedAt}</lastUpdatedAt>
                <extensions>{$ctx:extensions}</extensions>
            </eloquaStandardAPI.getAllContactLists>
            <respond/>
        </inSequence>
        <outSequence/>
        <faultSequence/>
    </target>
    <description/>
</proxy>