Working with Users in Producteev

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.

Operation	Description
createSubscriberList	Creates a new subscriber list in your Sendloop account.
getSubscriberList	Retrieves details of a specific subscriber list.
listSubscriberLists	Retrieves back your subscriber lists.
updateSubscriberList	Updates information of a subscriber list.

Operation details

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

Creating a new subscriber list

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

createSubscriberList

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

Sample request

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

Sample 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"
}

Retrieving details of a specific subscriber list

The getSubscriberList operation retrieves details of a specific subscriber list.

getSubscriberList

<sendloop.getSubscriberList>
    <subscriberListId>{$ctx:subscriberListId}</subscriberListId>
	<getCustomFields>{$ctx:getCustomFields}</getCustomFields>
</sendloop.getSubscriberList>

Properties

subscriberListId: Required - 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).

Sample request

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

Sample Request for getSubscriberList

{
    "apiUrl": "https://b1baa4a-ae4d45.sendloop.com",
    "apiKey": "e470-fb56-ee1f-e561-ed5e-987d-0340-e119",
    "format": "json",
    "subscriberListId": 8,
    "getCustomFields": 1
}

Retrieving back your subscriber lists

The listSubscriberLists operation retrieves back your subscriber lists.

listSubscriberLists

<sendloop.listSubscriberLists>
</sendloop.listSubscriberLists>

Sample request

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

Sample Request for listSubscriberLists

{
    "apiUrl": "https://b1baa4a-ae4d45.sendloop.com",
    "apiKey": "e470-fb56-ee1f-e561-ed5e-987d-0340-e119",
    "format": "json"
}

Updating information of a subscriber list

The updateSubscriberList operation updates information of a subscriber list.

updateSubscriberList

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

Sample request

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

Sample 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
}

Sample configuration

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

Sample Proxy

<?xml version="1.0" encoding="UTF-8"?>
<proxy name="sendloop_createSubscriberList" 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="apiKey" expression="json-eval($.apiKey)"/>
         <property name="format" expression="json-eval($.format)"/>
         <property name="listName" expression="json-eval($.listName)"/>
         <property name="optInMode" expression="json-eval($.optInMode)"/>
         <sendloop.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <apiKey>{$ctx:apiKey}</apiKey>
            <format>{$ctx:format}</format>
         </sendloop.init>
         <sendloop.createSubscriberList>
            <listName>{$ctx:listName}</listName>
            <optInMode>{$ctx:optInMode}</optInMode>
         </sendloop.createSubscriberList>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>

Overview

Operation details

Creating a new subscriber list

Properties

Sample request

Related Sendloop documentation

Retrieving details of a specific subscriber list

Properties

Sample request

Related Sendloop documentation

Retrieving back your subscriber lists

Sample request

Related Sendloop documentation

Updating information of a subscriber list

Properties

Sample request

Related Sendloop documentation

Sample configuration