Working with Email Groups

Overview

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

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

For more details click Email Groups.

Operation	Description
createAnEmailGroup	Creates a new email group.
updateAnEmailGroup	Updates an email group.
getAllEmailGroups	Retrieves all email groups.
getAnEmailGroup	Retrieves an email group associated with the email group id.
deleteAnEmailGroup	Deletes an email group associated with the specified email group id.

Operation Details

This section provides further details on the operations related to Email Groups.

Create An Email Group

The createAnEmailGroup operation creates a new email group.

createAnEmailGroup

<eloquaStandardAPI.createAnEmailGroup>
    <name>IT group</name>
    <isVisibleInOutlookPlugin>true</isVisibleInOutlookPlugin>
    <emailIds>["1"]</emailIds>
    <displayName>IT group</displayName>
    <subscriptionListId>12</subscriptionListId>
    <unSubscriptionListId>13</unSubscriptionListId>
    <subscriptionListDataLookupId>933089ea-224c-476c-a182-b34791557a71</subscriptionListDataLookupId>
    <unSubscriptionListDataLookupId>2770a778-81b8-4eaf-af16-b0cc9e2ea1b3</unSubscriptionListDataLookupId>
    <emailHeaderId>1</emailHeaderId>
    <emailFooterId>1</emailFooterId>
    <subscriptionLandingPageId>5</subscriptionLandingPageId>
    <unsubscriptionLandingPageId>6</unsubscriptionLandingPageId>
    "isVisibleInPublicSubscriptionList>true</isVisibleInPublicSubscriptionList>
</eloquaStandardAPI.createAnEmailGroup>

properties

name : Name of the email group.
isVisibleInOutlookPlugin : Boolean value, to indicate the visibility to public subscription list.
emailIds : List of email ids.
displayName : The name of the group visible for others.
subscriptionListId : Id of the subscription list.
unSubscriptionListId : Id of the unsubscription list.
subscriptionListDataLookupId : Data lookup id of the subscription list.
unSubscriptionListDataLookupId : Unsubscription Data lookup id.
emailHeaderId : Id of the email header.
emailFooterId : Id of the email footer.
subscriptionLandingPageId : Unique identifier of subscription landing page value.
unsubscriptionLandingPageId : Unique identifier of unsubscription landing page value.
isVisibleInPublicSubscriptionList : Boolean value, to indicate the visibility to public subscription list.

Sample request

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

Sample request for createAnEmailGroup

{
   "username":"myusername",
   "password":"mypassword",
   "siteName":"mysiteName",
   "name":"IT group",
   "isVisibleInOutlookPlugin":true,   
   "emailIds":["1"],
   "displayName":"IT group",
   "subscriptionListId":"12",
   "unSubscriptionListId":"13",
   "subscriptionListDataLookupId":"933089ea-224c-476c-a182-b34791557a71",
   "unSubscriptionListDataLookupId":"2770a778-81b8-4eaf-af16-b0cc9e2ea1b3",
   "emailHeaderId":"1",
   "emailFooterId":"1",
   "subscriptionLandingPageId":"5",
   "unsubscriptionLandingPageId":"6",
   "isVisibleInPublicSubscriptionList":true
}

Update An Email Group

The updateAnEmailGroup operation updates an email group.

updateAnEmailGroup

<eloquaStandardAPI.updateAnEmailGroup>
    <emailGroupId>1</emailGroupId>
    <name>IT group</name>
    <isVisibleInOutlookPlugin>true</isVisibleInOutlookPlugin>
    <emailIds>["1"]</emailIds>
    <displayName>IT group</displayName>
    <subscriptionListId>12</subscriptionListId>
    <unSubscriptionListId>13</unSubscriptionListId>
    <subscriptionListDataLookupId>933089ea-224c-476c-a182-b34791557a71</subscriptionListDataLookupId>
    <unSubscriptionListDataLookupId>2770a778-81b8-4eaf-af16-b0cc9e2ea1b3</unSubscriptionListDataLookupId>
    <emailHeaderId>1</emailHeaderId>
    <emailFooterId>1</emailFooterId>
    <subscriptionLandingPageId>5</subscriptionLandingPageId>
    <unsubscriptionLandingPageId>6</unsubscriptionLandingPageId>
    <isVisibleInPublicSubscriptionList>true</isVisibleInPublicSubscriptionList>
</eloquaStandardAPI.updateAnEmailGroup>

properties

emailGroupId : Unique identifier of the email group.
name : Name of the email group.
isVisibleInOutlookPlugin : Boolean value, to indicate the visibility to public subscription list.
emailIds : List of email ids.
displayName : The name of the group visible for others.
subscriptionListId : Id of the subscription list.
unSubscriptionListId : Id of the unsubscription list.
subscriptionListDataLookupId : Data lookup id of the subscription list.
unSubscriptionListDataLookupId : Unsubscription Data lookup id.
emailHeaderId : Id of the email header.
emailFooterId : Id of the email footer.
subscriptionLandingPageId : Unique identifier of subscription landing page value.
unsubscriptionLandingPageId : Unique identifier of unsubscription landing page value.
isVisibleInPublicSubscriptionList : Boolean value, to indicate the visibility to public subscription list.

Sample request

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

Sample request for updateAnEmailGroup

{   
   "username":"myusername",
   "password":"mypassword",
   "siteName":"mysiteName",
   "emailGroupId":"1",
   "name":"IT group",
   "isVisibleInOutlookPlugin":true,   
   "emailIds":["1"],
   "displayName":"IT group",
   "subscriptionListId":"12",
   "unSubscriptionListId":"13",
   "subscriptionListDataLookupId":"933089ea-224c-476c-a182-b34791557a71",
   "unSubscriptionListDataLookupId":"2770a778-81b8-4eaf-af16-b0cc9e2ea1b3",
   "emailHeaderId":"1",
   "emailFooterId":"1",
   "subscriptionLandingPageId":"5",
   "unsubscriptionLandingPageId":"6",
   "isVisibleInPublicSubscriptionList":true
}

Get All Email Groups

The getAllEmailGroups operation retrieves all email groups.

getAllEmailGroups

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

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 extensions to filter. Must follow the pattern : ^[A-Za-z0-9]+$.

Sample Request

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

Sample request for getAllEmailGroups

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

Get An Email Group

The getAnEmailGroup operation retrieves the details of an email group associated with the specified email group id.

getAnEmailGroup

<eloquaStandardAPI.getAnEmailGroup>
	<emailGroupId>1</emailGroupId>
	<depth>Complete</depth>
	<extensions>1</extensions>
</eloquaStandardAPI.getAnEmailGroup>

properties

emailGroupId : Unique identifier of the email group.
depth :The RequestDepth. It can be 'Complete' or 'Reference' or 'Minimal' or 'Partial'.
extensions :The extensions to filter. Must follow the pattern : ^[A-Za-z0-9]+$.

Sample request

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

Sample request for getAnEmailGroup

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

Delete An Email Group

The deleteAnEmailGroup operation deletes the email group associated with the specified account id.

deleteAnEmailGroup

<eloquaStandardAPI.deleteAnEmailGroup>
	<emailGroupId>1</emailGroupId>
</eloquaStandardAPI.deleteAnEmailGroup>

properties

emailGroupId : Unique identifier of the email group.

Sample request

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

Sample request for deleteAnEmailGroup

{  
   "username":"myusername",
   "password":"mypassword",
   "siteName":"mysiteName",
   "emailGroupId":"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 getAllEmailGroups operation. The sample request for this proxy can be found in getAllEmailGroups 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_getAllEmailGroups"
       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.getAllEmailGroups>
                <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.getAllEmailGroups>
            <respond/>
        </inSequence>
        <outSequence/>
        <faultSequence/>
    </target>
    <description/>
</proxy>