Working with Mailing Lists in ActiveCampaign

Overview

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

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

Operation	Description
createMailingList	Creates a new mailing list.
listMailingLists	Retrieves all mailing lists.

Operation details

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

Creating a new mailing list

The createMailingList operation creates a new mailing list.

createMailingList

<activecampaign.createMailingList>
    <twitterPass>{$ctx:twitterPass}</twitterPass>
    <toName>{$ctx:toName}</toName>
    <senderAddr1>{$ctx:senderAddr1}</senderAddr1>
    <senderZip>{$ctx:senderZip}</senderZip>
    <getUnsubscribeReason>{$ctx:getUnsubscribeReason}</getUnsubscribeReason>
    <pUseTwitter>{$ctx:pUseTwitter}</pUseTwitter>
    <subscriptionNotifyList>{$ctx:subscriptionNotifyList}</subscriptionNotifyList>
    <requireName>{$ctx:requireName}</requireName>
    <private>{$ctx:private}</private>
    <senderCountry>{$ctx:senderCountry}</senderCountry>
    <twitterUser>{$ctx:twitterUser}</twitterUser>
    <senderName>{$ctx:senderName}</senderName>
    <unsubscriptionNotifyList>{$ctx:unsubscriptionNotifyList}</unsubscriptionNotifyList>
    <senderCity>{$ctx:senderCity}</senderCity>
    <name>{$ctx:name}</name>
    <pUseCaptcha>{$ctx:pUseCaptcha}</pUseCaptcha>
    <senderUrl>{$ctx:senderUrl}</senderUrl>
    <carbonCopyList>{$ctx:carbonCopyList}</carbonCopyList>
    <bounceId>{$ctx:bounceId}</bounceId>
    <sendLastBroadcast>{$ctx:sendLastBroadcast}</sendLastBroadcast>
   	<senderReminder>{$ctx:senderReminder}</senderReminder>
	<stringId>{$ctx:stringId}</stringId>
</activecampaign.createMailingList>

Properties

twitterPass: The Twitter account password.
toName: The name to use if the contact does not enter any name.
senderAddr1: The physical mailing address of the sender.
senderZip: The physical mailing address: zip or postal code of the sender.
getUnsubscribeReason: Indicates whether to ask for reason when unsubscribing.
pUseTwitter: Indicates whether to send this campaign to Twitter.
subscriptionNotifyList: The comma-separated list of e-mail addresses to notify new subscriptions to this list.
requireName: Indicates whether the name is required with e-mail address when subscribing.
private: Indicates whether to hide it on public side.
senderCountry: The physical mailing country of the sender.
twitterUser: The Twitter account username.
senderName: The name of the sender.
unsubscriptionNotifyList: The comma-separated list of e-mail addresses to notify on unsubscribing from this list.
senderCity: The physical mailing city of the sender.
name: The internal list name.
pUseCaptcha: Indicates whether CAPTCHA is required.
senderUrl: The website associated with this list.
carbonCopyList: The comma-separated list of e-mail addresses to send a copy of all mailings.
bounceId: The type of the split mailing.
sendLastBroadcast: Indicates whether to send the last broadcast campaign when subscribing.
senderReminder: The reminder to the contacts as to why they are on this list and why you are sending the e-mail.
stringId: The URL-safe list name.

Sample request

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

Sample Request for createMailingList

{
    "apiOutput": "json",
    "apiUrl": "http://anusoft.api-us1.com",
    "apiKey": "540ba94be91183bc40ab95efb582d6a6792ccb65da2a48368ece87309447099098f559d8",
    "name": "listMyList2",
    "subscriptionNotifyList": "test1@gmail.com,test2@yahoo.com",
    "unsubscriptionNotifyList": "test3@gmail.com,test4@yahoo.com",
    "toName": "recepient",
    "carbonCopyList": "testtest1@gmail.com,testtest2@yahoo.com",
    "stringId": "apitest",
    "pUseTwitter": "1",
    "twitterUser": "disapptests@gmail.com",
    "twitterPass": "1",
    "bounceId": "disapptests@gmail.com,testtest1@gmail.com",
    "pUseCaptcha": "1",
    "getUnsubscribeReason": "1",
    "sendLastBroadcast": "1",
    "requireName": "1",
    "private": "1",
    "senderAddr1": "aaaa",
    "senderZip": "94",
    "senderCountry": "Sri Lanka",
    "senderName": "WSO2",
    "senderCity": "Colombo",
    "senderUrl": "https://www.google.lk",
    "senderReminder": "aaa"
}

Retrieving all mailing lists

The listMailingLists operation retrieves all mailing lists.

listMailingLists

<activecampaign.listMailingLists>
    <isGlobalFields>{$ctx:isGlobalFields}</isGlobalFields>
    <isFull>{$ctx:isFull}</isFull>
    <nameFilter>{$ctx:nameFilter}</nameFilter>
	<ids>{$ctx:ids}</ids>
</activecampaign.listMailingLists>

Properties

isGlobalFields: Indicates whether to include global custom fields.
isFull: Indicates whether to return ALL data or an abbreviated portion only.
nameFilter: Performs a pattern match for List Name.
ids: A comma-separated list of subscription form IDs of lists.

Sample request

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

listMailingLists

{
	"apiOutput":"json",
	"apiUrl":"http://anusoft.api-us1.com",
	"apiKey":"540ba94be91183bc40ab95efb582d6a6792ccb65da2a48368ece87309447099098f559d8",
	"isGlobalFields":"true",
	"isFull":"1",
	"nameFilter":"",
	"ids":"1,2"
}

Sample configuration

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

Sample Proxy

<?xml version="1.0" encoding="UTF-8"?>
	<proxy xmlns="http://ws.apache.org/ns/synapse" name="activecampaign_createMailingList" transports="https,http" statistics="disable" trace="disable" startOnLoad="true">
	 <target>
	 <inSequence>
      <property name="apiOutput" expression="json-eval($.apiOutput)"/>
      <property name="apiUrl" expression="json-eval($.apiUrl)"/>
      <property name="apiKey" expression="json-eval($.apiKey)"/>
      <property name="twitterPass" expression="json-eval($.twitterPass)"/>
      <property name="toName" expression="json-eval($.toName)"/>
      <property name="senderAddr1" expression="json-eval($.senderAddr1)"/>
      <property name="senderZip" expression="json-eval($.senderZip)"/>
      <property name="getUnsubscribeReason" expression="json-eval($.getUnsubscribeReason)"/>
      <property name="pUseTwitter" expression="json-eval($.pUseTwitter)"/>
      <property name="subscriptionNotifyList" expression="json-eval($.subscriptionNotifyList)"/>
      <property name="requireName" expression="json-eval($.requireName)"/>
      <property name="private" expression="json-eval($.private)"/>
      <property name="senderCountry" expression="json-eval($.senderCountry)"/>
      <property name="twitterUser" expression="json-eval($.twitterUser)"/>
      <property name="senderName" expression="json-eval($.senderName)"/>
      <property name="unsubscriptionNotifyList" expression="json-eval($.unsubscriptionNotifyList)"/>
      <property name="senderCity" expression="json-eval($.senderCity)"/>
      <property name="name" expression="json-eval($.name)"/>
      <property name="pUseCaptcha" expression="json-eval($.pUseCaptcha)"/>
      <property name="senderUrl" expression="json-eval($.senderUrl)"/>
      <property name="carbonCopyList" expression="json-eval($.carbonCopyList)"/>
      <property name="bounceId" expression="json-eval($.bounceId)"/>
      <property name="sendLastBroadcast" expression="json-eval($.sendLastBroadcast)"/>
      <property name="senderReminder" expression="json-eval($.senderReminder)"/>
      <property name="stringId" expression="json-eval($.stringId)"/>
      <activecampaign.init>
         <apiOutput>{$ctx:apiOutput}</apiOutput>
         <apiUrl>{$ctx:apiUrl}</apiUrl>
         <apiKey>{$ctx:apiKey}</apiKey>
      </activecampaign.init>
      <activecampaign.createMailingList>
         <twitterPass>{$ctx:twitterPass}</twitterPass>
         <toName>{$ctx:toName}</toName>
         <senderAddr1>{$ctx:senderAddr1}</senderAddr1>
         <senderZip>{$ctx:senderZip}</senderZip>
         <getUnsubscribeReason>{$ctx:getUnsubscribeReason}</getUnsubscribeReason>
         <pUseTwitter>{$ctx:pUseTwitter}</pUseTwitter>
         <subscriptionNotifyList>{$ctx:subscriptionNotifyList}</subscriptionNotifyList>
         <requireName>{$ctx:requireName}</requireName>
         <private>{$ctx:private}</private>
         <senderCountry>{$ctx:senderCountry}</senderCountry>
         <twitterUser>{$ctx:twitterUser}</twitterUser>
         <senderName>{$ctx:senderName}</senderName>
         <unsubscriptionNotifyList>{$ctx:unsubscriptionNotifyList}</unsubscriptionNotifyList>
         <senderCity>{$ctx:senderCity}</senderCity>
         <name>{$ctx:name}</name>
         <pUseCaptcha>{$ctx:pUseCaptcha}</pUseCaptcha>
         <senderUrl>{$ctx:senderUrl}</senderUrl>
         <carbonCopyList>{$ctx:carbonCopyList}</carbonCopyList>
         <bounceId>{$ctx:bounceId}</bounceId>
         <sendLastBroadcast>{$ctx:sendLastBroadcast}</sendLastBroadcast>
         <senderReminder>{$ctx:senderReminder}</senderReminder>
         <stringId>{$ctx:stringId}</stringId>
      </activecampaign.createMailingList>
	   <respond/>
	 </inSequence>
	  <outSequence>
	   <log/>
	   <send/>
	  </outSequence>
	 </target>
   <description/>
  </proxy>

WSO2 ESB Connectors Documentation

Working with Mailing Lists in ActiveCampaign

Overview

Operation details

Creating a new mailing list

Properties

Sample request

Related ActiveCampaign documentation

Retrieving all mailing lists

Properties

Sample request

Related ActiveCampaign documentation

Sample configuration