Table of Contents | ||||
---|---|---|---|---|
|
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 |
---|---|
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.
...
The
operation creates a new subscriber list in your Sendloop account.createSubscriberList
Code Block | ||||
---|---|---|---|---|
| ||||
<sendloop.createSubscriberList>
<listName>{$ctx:listName}</listName>
<optInMode>{$ctx:optInMode}</optInMode>
</sendloop.createSubscriberList> |
Properties
Required - The name of the new subscriber list.listName:
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'.optInMode:
...
Following is a sample REST/JSON request that can be handled by the createSubscriberList
operation.
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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
operation retrieves details of a specific subscriber list.The getSubscriberList
operation retrieves a specific user. getUser
Code Block | ||||
---|---|---|---|---|
| ||||
<sendloop.getSubscriberList> <subscriberListId>{$ctx:subscriberListId}</subscriberListId> <getCustomFields><producteev.getUser> <userId>{$ctx:getCustomFieldsuserId}</getCustomFields>userId> </sendloopproducteev.getSubscriberList>getUser> |
Properties
Required - The ID of the subscriber list whose details would be retrieved.subscriberListIduserId:
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).getCustomFields:
...
- user to find.
Anchor | ||||
---|---|---|---|---|
|
Following is a sample REST/JSON request that can be handled by the getSubscriberList
getUser
operation.
Code Block | ||||
---|---|---|---|---|
| ||||
{ "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
operation retrieves back your subscriber lists.listSubscriberLists
Code Block | ||||
---|---|---|---|---|
| ||||
<sendloop.listSubscriberLists>
</sendloop.listSubscriberLists> |
...
Following is a sample REST/JSON request that can be handled by the listSubscriberLists
operation.
...
language | xml |
---|---|
title | Sample Request for listSubscriberLists |
...
Producteev documentation
...
Related Sendloop documentation
https://sendloop.com/help/api-005/subscriber-list-management#list_getlist
...
The
operation updates information of a subscriber list.updateSubscriberList
Code Block | ||||
---|---|---|---|---|
| ||||
<sendloop.updateSubscriberList>
<listName>{$ctx:listName}</listName>
<optInMode>{$ctx:optInMode}</optInMode>
<subscriberListId>{$ctx:subscriberListId}</subscriberListId>
</sendloop.updateSubscriberList> |
Properties
Required - The name of the new subscriber list.listName:
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'.optInMode:
- The ID of the subscriber list to update.subscriberListId:
...
Following is a sample REST/JSON request that can be handled by the updateSubscriberList
operation.
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
|
Following is a sample proxy service that illustrates how to connect to Sendloop Producteev with the init
operation and use the
the createSubscriberList
operation. The sample request for this proxy can be found in the createSubscriberList getUser sample request.getUser
Code Block | ||||
---|---|---|---|---|
| ||||
<?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> |