Versions Compared

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 subscriber lists. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with subscriber lists, see Sample configuration

OperationDescription

createSubscriberList

Creates a new subscriber list in your Sendloop account.

getSubscriberList

Retrieves details of a specific subscriber list.

listSubscriberListsRetrieves back your subscriber lists.
updateSubscriberListUpdates information of a subscriber list.

Operation details

This section provides further details on the operations related to subscriber lists.

...

The createSubscriberList operation creates a new subscriber list in your Sendloop account.

Code Block
languagexml
titlecreateSubscriberList
<sendloop.createSubscriberList>
    <listName>{$ctx:listName}</listName>
	<optInMode>{$ctx:optInMode}</optInMode>
</sendloop.createSubscriberList>
Properties
  • listName: Required - The name of the new subscriber list.
  • optInMode: Required - Set the subscription type. It can be opt-in (no e-mail confirmation will be sent) or double opt-in (confirmation e-mail will be sent - recommended). Pass 'Single' or 'Double'.

...

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

Code Block
languagexml
titleSample Request for createSubscriberList
{
    "apiUrl": "https://b1baa4a-ae4d45.sendloop.com",
    "apiKey": "e470-fb56-ee1f-e561-ed5e-987d-0340-e119",
    "format": "json",
    "listName": "List Name A001",
    "optInMode": "Single"
}
Related Sendloop documentation

https://sendloop.com/help/api-005/subscriber-list-management#list_create

...

The getSubscriberList operation retrieves details of a specific subscriber list.The getUser operation retrieves a specific user. 

Code Block
languagexml
titlegetSubscriberList getUser
<sendloop.getSubscriberList>
    <subscriberListId>{$ctx:subscriberListId}</subscriberListId>
	<getCustomFields><producteev.getUser>
	<userId>{$ctx:getCustomFieldsuserId}</getCustomFields>userId>
</sendloopproducteev.getSubscriberList>getUser>
Properties
  • subscriberListIduserIdRequired - The ID of the subscriber list whose details would be retrieved.
  • getCustomFields: Required - If it is set to 1, API call will return the list of created custom fields for the target list. To disable this feature, set it to 0 (zero).

...

  • user to find.
Anchor
request
request
Sample request

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

Code Block
languagexml
titleSample Request for getSubscriberListgetUser
{
    "apiUrl": "https://b1baa4a-ae4d45www.sendloopproducteev.com",
    "apiKeyaccessToken": "e470-fb56-ee1f-e561-ed5e-987d-0340-e119OTg4ZGY0NTgxZTE2ZDYzODNjNDUzZWUzMTI4YmExNzhiMDM2MTllNzNlYWQyMmY4ODk5YjQ1Mzc0ZGQxZjAxOA",
    "formatuserId": "json",
    "subscriberListId": 8,
    "getCustomFields": 151e83d8bfa46341808000029"
}
Related

...

https://sendloop.com/help/api-005/subscriber-list-management#list_get

...

The listSubscriberLists operation retrieves back your subscriber lists.

Code Block
languagexml
titlelistSubscriberLists
<sendloop.listSubscriberLists>
</sendloop.listSubscriberLists>

...

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

...

languagexml
titleSample Request for listSubscriberLists

...

Producteev documentation

 https://

...

Related Sendloop documentation

https://sendloop.com/help/api-005/subscriber-list-management#list_getlist

...

The updateSubscriberList operation updates information of a subscriber list.

Code Block
languagexml
titleupdateSubscriberList
<sendloop.updateSubscriberList>
    <listName>{$ctx:listName}</listName>
    <optInMode>{$ctx:optInMode}</optInMode>
	<subscriberListId>{$ctx:subscriberListId}</subscriberListId>
</sendloop.updateSubscriberList>
Properties
  • listName: Required - The name of the new subscriber list.
  • optInMode: Set the subscription type. It can be opt-in (no e-mail confirmation will be sent) or double opt-in (confirmation e-mail will be sent - recommended). Pass 'Single' or 'Double'.
  • subscriberListId: -  The ID of the subscriber list to update.

...

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

Code Block
languagexml
titleSample Request for updateSubscriberList
{
    "apiUrl": "https://b1baa4a-ae4d45.sendloop.com",
    "apiKey": "e470-fb56-ee1f-e561-ed5e-987d-0340-e119",
    "format": "json",
    "listName": "List Name A001 - Updated",
    "optInMode": "Double",
    "subscriberListId": 8
}
Related Sendloop documentation

https://sendloop.com/help/api-005/subscriber-list-management#list_settings_update

...

www.producteev.com/api/doc/#Get current user

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

Following is a sample proxy service that illustrates how to connect to Sendloop Producteev with the init operation and use the createSubscriberList the  getUser operation. The sample request for this proxy can be found in the createSubscriberList getUser sample request.

Code Block
languagexml
titleSample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy name="sendloopproducteev_createSubscriberListgetUser" startOnLoad="true" statistics="disable" trace="disable" transports="https,http" xmlns="http://ws.apache.org/ns/synapse">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="apiUrl" expression="json-eval($.apiUrl)"/>
         <property name="apiKeyaccessToken" expression="json-eval($.apiKeyaccessToken)"/>
         <property name="formatuserId" expression="json-eval($.formatuserId)"/>
         <property name="listName" expression="json-eval($.listName)"/>
         <property name="optInMode" expression="json-eval($.optInMode)"/>
         <sendloop<producteev.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <apiKey><accessToken>{$ctx:apiKeyaccessToken}</apiKey>
            <format>{$ctx:format}</format>accessToken>
         </sendloopproducteev.init>
         <sendloop<producteev.createSubscriberList>getUser>
            <listName><userId>{$ctx:listNameuserId}</listName>
 userId>
          <optInMode>{$ctx:optInMode}</optInMode>
         </sendloop.createSubscriberList></producteev.getUser>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>