BridgeMail System APIs
If you have access at BMS API area then you can
find BMS API access key (api_tk) from BridgeMail System --- Application
Integration --- BMS APIs
Note*
All requests will be handled as POST requests, Response will be return in CDATA
Login Method
Request URL
https://api.bridgemailsystem.com/pms/services/login/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<login>
<userId>demo</userId>
<api_tk>dmtXe8s4SOtzz5222342saferwer</api_tk>
</login>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok" />
In case of successfully login, 30 characters session token will be set in
response header.
i,e auth_tk : CDSachFszCDwwASu6lLZLbypoYEECM
This session will be valid for 30 mins.
POST request parameters
userId = [BridgeMail System
user ID]
api_tk = BMS API Access Key Get Subscriber Method
Get Subscriber Method
Request URL
https://api.bridgemailsystem.com/pms/services/getsubscriber/
XML Request
<?xml version="1.0" encoding="ISO-8859-1" ?>
<subscriber>
<email>babar@makesbridge.com</email>
</subscriber>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp>
<Subscriber>
<id>qcEwh30Te44Me26De17Ec20He21Pd30Zk33qEE</id>
<email>babar@makesbridge.com</email>
<firstName>Babar</firstName>
<middleName></middleName>
<lastName>Virk</lastName>
<birthDate>
</birthDate>
<gender> </gender>
<maritalStatus>
</maritalStatus>
<occupation> </occupation>
<householdIncome>
</householdIncome>
<educationLevel>
</educationLevel>
<addressLine1>
</addressLine1>
<addressLine2>
</addressLine2>
<city></city>
<stateCode>
</stateCode>
<countryCode>
</countryCode>
<areaCode>
</areaCode>
<zip></zip>
<telephone>234323432</telephone>
<mobileNumber>12025550138</mobileNumber>
<industry>IT</industry>
<company>Makesbridge</company>
<source>Web Site</source>
<salesRep>Jay
Adams</salesRep>
<salesStatus>LEAD</salesStatus>
<customFields>
<customField name="customFld"
value="3223"></customField>
</customFields>
</Subscriber>
</rsp>
Add Subscriber Method
Request URL
https://api.bridgemailsystem.com/pms/services/addsubscriber/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<addsubscriber listName="babar_sf_testlist">
<Subscriber>
<email>babar@makesbridge.com</email>
<firstName>Babar</firstName>
<middleName>Ali</middleName>
<lastName>Virk</lastName>
<birthDate>1960-02-20</birthDate>
<gender>m</gender>
<maritalStatus>s</maritalStatus>
<occupation></occupation>
<householdIncome></householdIncome>
<educationLevel></educationLevel>
<addressLine1>park vally</addressLine1>
<addressLine2>zando
town</addressLine2>
<city>glacio</city>
<stateCode></stateCode>
<countryCode></countryCode>
<areaCode></areaCode>
<zip></zip>
<telephone>234323432</telephone>
<mobileNumber>12025550138</mobileNumber>
<industry>IT</industry>
<company>Makesbridge</company>
<source>Web Site</source>
<salesRep>Jay
Adams</salesRep>
<salesStatus>LEAD</salesStatus>
<customFields>
<customField name="customFld"
value="3223"></customField>
</customFields>
</subscriber>
<subscriber>
<email>virk@makesbridge.com</email>
<firstName>Babar</firstName>
<middleName>Ali</middleName>
<lastName>Virk</lastName>
<birthDate>1960-02-20</birthDate>
<gender>m</gender>
<maritalStatus>s</maritalStatus>
<occupation></occupation>
<householdIncome></householdIncome>
<educationLevel></educationLevel>
<addressLine1>park vally</addressLine1>
<addressLine2>zando
town</addressLine2>
<city>glacio</city>
<stateCode></stateCode>
<countryCode></countryCode>
<areaCode></areaCode>
<zip></zip>
<telephone>234323432</telephone>
<mobileNumber>12025550138</mobileNumber>
<industry>IT</industry>
<company>Makesbridge</company>
<source>Web Site</source>
<salesRep>Jay
Adams</salesRep>
<salesStatus>CONTACT</salesStatus>
<customFields>
<customField name="customFld22"
value="5555"></customField>
</customFields>
</subscriber>
</addsubscriber>
OR
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<addsubscriber listId="ecTwh22Te55gs26EE23GG00He21">
<subscriber>
<email>babar@makesbridge.com</email>
<firstName>Babar</firstName>
<middleName>Ali</middleName>
<lastName>Virk</lastName>
<birthDate>1960-02-20</birthDate>
<gender>m</gender>
<maritalStatus>s</maritalStatus>
<occupation></occupation>
<householdIncome></householdIncome>
<educationLevel></educationLevel>
<addressLine1>park vally</addressLine1>
<addressLine2>zando
town</addressLine2>
<city>glacio</city>
<stateCode></stateCode>
<countryCode></countryCode>
<areaCode></areaCode>
<zip></zip>
<telephone>234323432</telephone>
<mobileNumber>12025550138</mobileNumber>
<industry>IT</industry>
<company>Makesbridge</company>
<source>Web Site</source>
<salesRep>Jay
Adams</salesRep>
<salesStatus>LEAD</salesStatus>
<customFields>
<customField name="customFld"
value="3223"></customField>
</customFields>
</subscriber>
<subscriber>
<email>virk@makesbridge.com</email>
<firstName>Babar</firstName>
<middleName>Ali</middleName>
<lastName>Virk</lastName>
<birthDate>1960-02-20</birthDate>
<gender>m</gender>
<maritalStatus>s</maritalStatus>
<occupation></occupation>
<householdIncome></householdIncome>
<educationLevel></educationLevel>
<addressLine1>park vally</addressLine1>
<addressLine2>zando
town</addressLine2>
<city>glacio</city>
<stateCode></stateCode>
<countryCode></countryCode>
<areaCode></areaCode>
<zip></zip>
<telephone>234323432</telephone>
<mobileNumber>12025550138</mobileNumber>
<industry>IT</industry>
<company>Makesbridge</company>
<source>Web Site</source>
<salesRep>Jay
Adams</salesRep>
<salesStatus>CONTACT</salesStatus>
<customFields>
<customField name="customFld22"
value="5555"></customField>
</customFields>
</subscriber>
</addsubscriber>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok" added="2"
updated="0">
<subscriber>
<id>qcEwh30Te44Me26De17Ec20He21Pd30Zk33qEE</id>
<email>babar@makesbridge.com</email>
</subscriber>
<subscriber>
<id>ecTwh55Te55Me26De32EE00He21Pd30Zk32qSS</id>
<email>virk@makesbridge.com</email>
</subscriber>
</rsp>
Note* Add subscriber Method can only accept 200 subscribers in single request.
First subscriber's elements would be handled as a
Update Layout for subscribers against that request.
Get List Info Method
Request URL
https://api.bridgemailsystem.com/pms/services/getlistinfo/
XML Request
No XML required. Only need to call request URL.
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp>
<list>
<id>ecTwh22Te55gs26EE23GG00He21</id>
<name>list 1</name>
<subscribedCount>224</subscribedCount>
<userID>test</userID>
<creationDate>2011-01-01
16:25:24</creationDate>
</list>
<list>
<id>ecTSs22Es54Gs26Gg23eW00He21</id>
<name>list 2</name>
<subscribedCount>1000</subscribedCount>
<userID>test</userID>
<creationDate>2010-01-01
16:25:24</creationDate>
</list>
</rsp>
Get List Subscribers Method
Request URL
https://api.bridgemailsystem.com/pms/services/getlistsubs/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<getlist>
<name>list
1</name>
<page>1</page>
</getlist>
OR
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<getlist>
<id>ecTwh22Te55gs26EE23GG00He21</id>
<page>1</page>
</getlist>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp>
<Subscriber>
<email>babar@makesbridge.com</email>
<firstName>Babar</firstName>
</Subscriber>
<Subscriber>
<email>babar1@makesbridge.com</email>
<firstName>Babar</firstName>
</Subscriber>
<Subscriber>
<email>babar2@makesbridge.com</email>
<firstName>Babar</firstName>
</Subscriber>
<Subscriber>
<email>babar3@makesbridge.com</email>
<firstName>Babar</firstName>
</Subscriber>
<Subscriber>
<email>babar4@makesbridge.com</email>
<firstName>Babar</firstName>
</Subscriber>
</rsp>
POST request parameters
listName = [List name which exist at BridgeMail System]
listId = [BridgeMail System
List Id return in getlistinfo method]
page = [optional] if there are more than 500 subscribers in list then need to
set [page = 2] get next 500,1000 .
Create Campaign Method
Request URL
https://api.bridgemailsystem.com/pms/services/createcampaign/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<campaign isTextOnly="N" createWebVersion="Y" tellAFriend="Y"
subInfoUpdate="Y" USM="N">
<name>api test campaign</name>
<subject>api subject test</subject>
<body>
<![CDATA[
<html><body>This is api test
campaign <a href="http://www.bridgemailsystem.com">BMS</a>
yes.</body></html>
]]>
</body>
<senderName>BMS API</senderName>
<replyTo>demo@makesbridge.com</replyTo>
<footerText>Makesbridge
Technology, 526 Newville Drive, Los Gatos, CA 95032.</footerText>
<sfid>801400000004aVEBBY</sfid>
</campaign>
OR
Success
Response
<?xml
version="1.0" encoding="ISO-8859-1"?>
<rsp status="ok">
<id>ecTwh22Te55gs26EE23GG00He21</id>
</rsp>
POST request parameters
body = HTML code should be included in <![CDATA[
.... ]]>
Update Campaign Method
Request URL
https://api.bridgemailsystem.com/pms/services/updatecampaign/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<campaign isTextOnly="N" createWebVersion="Y" tellAFriend="Y"
USM="N">
<name>api test campaign</name>
<subject>api subject test</subject>
<body>
<![CDATA[
<html><body>This is api update
test campaign <a href="http://www.bridgemailsystem.com">BMS</a>
yes.</body></html>
]]>
</body>
<senderName>BMS API</senderName>
<replyTo>demo@makesbridge.com</replyTo>
<footerText>Makesbridge
Technology, 526 Newville Drive, Los Gatos, CA 95032.</footerText>
<sfid>801400000004aVEBBY</sfid>
<targetLists>
<list>babar_sf_testlist</list>
</targetLists>
</campaign>
OR
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<campaign isTextOnly="N" createWebVersion="Y" tellAFriend="Y"
USM="N">
<id>qcWPd30Xi22Og26We17Lj20qcW</id>
<subject>api subject test</subject>
<body>
<![CDATA[
<html><body>This is api update
test campaign <a href="http://www.bridgemailsystem.com">BMS</a>
yes.</body></html>
]]>
</body>
<senderName>BMS API</senderName>
<replyTo>demo@makesbridge.com</replyTo>
<footerText>Makesbridge
Technology, 526 Newville Drive, Los Gatos, CA 95032.</footerText>
</campaign>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok" />
POST request parameters
body = HTML code should be included in <![CDATA[
.... ]]>
Schedule Campaign Method
Request URL
https://api.bridgemailsystem.com/pms/services/schedulecampaign/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<campaign>
<name>api test campaign</name>
<scheduledDate>2011-06-20 08:20</scheduledDate>
</campaign>
OR
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<campaign>
<id>qcWPd30Xi22Og26We17Lj20qcW</id>
<scheduledDate>2011-06-20 08:20</scheduledDate>
</campaign>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok" />
POST request parameters
scheduledDate = scheduleDate
should be in format (yyyy-MM-dd
HH:mm)
Create List Method
Request URL
https://api.bridgemailsystem.com/pms/services/createlist/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<list>
<name>api test list</name>
</list>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok">
<id>qcWPd30Xi22Og26We17Lj20qcW</id>
</rsp>
Get WorkflowList
Method
Request URL
https://api.bridgemailsystem.com/pms/services/getworkflowlist/
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok">
<Workflow>
<id>jbGs21Ux32344sff</id>
<name>Member Of</name>
<creationDate>2011-06-02 00:29</creationDate>
<play>true</play>
<manualAddition>false</manualAddition>
<lastActivationDate>2011-06-02 00:52</lastActivationDate>
<Steps>
<Step>
<label>My
Step ONE</label>
<stepOrder>1</stepOrder>
<creationDate>2011-06-02 00:29</creationDate>
</Step>
</Steps>
</Workflow>
<Workflow>
<id>jbGs21werrtrt22</id>
<name>Birthday Piror DayOf</name>
<creationDate>2011-06-02 00:12</creationDate>
<play>true</play>
<manualAddition>true</manualAddition>
<Steps>
<Step>
<label>My
Step ONE</label>
<stepOrder>1</stepOrder>
<creationDate>2011-06-02 00:12</creationDate>
</Step>
<Step>
<label>My Step TWO</label>
<stepOrder>2</stepOrder>
<creationDate>2011-06-02 00:16</creationDate>
</Step>
</Steps>
</Workflow>
</rsp>
Add to Workflow Method
Request URL
https://api.bridgemailsystem.com/pms/services/addtoworkflow/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<addtoworkflow>
<workflowId>jbGs21werrtrt22</workflowId>
<subscriberId>zdTyioEk17Fi20Km23432sfsfs3432frtg</subscriberId>
<stepOrder>1</stepOrder>
<overrideRules>N</overrideRules>
</addtoworkflow>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok" />
Get Custom Fields Info Method
Request URL
https://api.bridgemailsystem.com/pms/services/getcustinfo/
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok">
<CustomField>
<name>X30_day_Trial_sign_up_date__c</name>
<userID>test</userID>
</CustomField>
<CustomField>
<name>employees</name>
<userID>test</userID>
</CustomField>
<CustomField>
<name>revenue</name>
<userID>test</userID>
</CustomField>
<CustomField>
<name>website</name>
<userID>test_subUser</userID>
</CustomField>
</rsp>
Get Campaign Info Method
Request URL
https://api.bridgemailsystem.com/pms/services/getcampaigninfo/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<getcampaign>
<page>1</page>
</getcampaign>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok">
<Campaign>
<id>kzwewedfweee22222sds0kzaqw</id>
<name>IOP</name>
<userID>demo</userID>
<creationDate>2007-12-26 05:11</creationDate>
<type>Normal</type>
<status>Draft</status>
</Campaign>
<Campaign>
<id>Bweewww323232gsssaAEqws</id>
<name>BriageMail Echo</name>
<userID>demo</userID>
<creationDate>2008-01-02 23:18</creationDate>
<type>Normal</type>
<status>Draft</status>
</Campaign>
<Campaign>
<id>qcweww22211e6Ij17Mk20qcW</id>
<name>Check test</name>
<userID>demo</userID>
<creationDate>2008-01-02 23:19</creationDate>
<type>Normal</type>
<status>Completed</status>
</Campaign>
<Campaign>
<id>wrewr26Aa17Hesfdsfzaqw</id>
<name>JJukj</name>
<userID>demo</userID>
<creationDate>2008-01-02 23:21</creationDate>
<type>Normal</type>
<status>Completed</status>
</Campaign>
</rsp>
POST request parameters
page = [optional] if there are more than 500 campaigns then need to set [page =
2] get next 500,1000 .
Get Campaign Detail Method
Request URL
https://api.bridgemailsystem.com/pms/services/getcampaigndetail/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<campaign>
<id>BzAEqwsFl2332345dfgdfg3436BzAEqws</id>
</campaign>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok">
<Campaign isTextOnly="N" tellAFriend="Y"
subInfoUpdate="N" USM="N" createWebVersion="N">
<id>BzAEqwsFl2332345dfgdfg3436BzAEqws</id>
<name>trade show us and canada</name>
<subject>Trade show coming</subject>
<body>this is sample</body>
<fromEmail>MakesBridge
Technology <bms@bridgemailsystem.com></fromEmail>
<replyTo>jadams@makesbridge.com</replyTo>
<webversionURL>http://www.bridgemailsystem.com/pms/webversion/xhDfV.html</webversionURL>
<senderName />
<footerText />
<userID>demo</userID>
<creationDate>2008-05-06 11:41</creationDate>
<type>Normal</type>
<status>Completed</status>
<targetLists>
<list>
<id>kzaqwSdsfwewg20Hd21kvfre</id>
<name>list1</name>
<userID>demo</userID>
</list>
</targetLists>
</Campaign>
</rsp>
Get Campaign Statistics
Method
Request URL
https://api.bridgemailsystem.com/pms/services/getcampaignstat/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<campaign>
<id>BzAEqwsFl2332345dfgdfg3436BzAEqws</id>
</campaign>
Success Response
<?xml version="1.0" encoding="ISO-8859-1"?>
<rsp status="ok">
<Campaign>
<id>BzAEqwsFl2332345dfgdfg3436BzAEqws</id>
<name>SegTest_100_102</name>
<userID>demo</userID>
<type>Normal</type>
<creationDate>2009-01-14 03:06</creationDate>
<scheduledDate>2009-01-14 00:00</scheduledDate>
<sentCount>3</sentCount>
<openCount>3</openCount>
<clickCount>0</clickCount>
<forwardCount>0</forwardCount>
<bounceCount>0</bounceCount>
<unSubscribedCount>0</unSubscribedCount>
<suppressCount>0</suppressCount>
<cancelCount>0</cancelCount>
</Campaign>
</rsp>
Get Subscriber Web
Tracking Ticket Method
Request URL
https://api.bridgemailsystem.com/pms/services/getwebtrackingticket/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<WebTracking>
<subscriberId>BzAEqwsFl2332345d3436BzAEqws</subscriberId>
<email>jaimeenol@test.com</email>
<campaignId>eeGqwsFsddadd3436BzAEqll</campaignId>
</WebTracking>
Success Response
<?xml
version="1.0" encoding="ISO-8859-1"?>
<rsp status="ok">
<bms.tk>qcWSg30Wdsdsfwd17Ieww21qNm</bms.tk>
</rsp>
POST request parameters
subscriberId = [subscriberId which return against Bridgemail System subscriber]
email = [Bridgemail System subscriber’s email]
campaignId = [optional] Bridgemail System campaign id .
Get Subscriber Activity
Method
Request URL
https://api.bridgemailsystem.com/pms/services/getsubscriberactivity/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<subscriber>
<id>BzAEqwsFdsfs2245d3436BzAEqws</id>
</subscriber>
Success Response
<?xml version="1.0"
encoding="ISO-8859-1"?>
<rsp status="ok">
<Event>
<time>2011-11-06
11:41</time>
<type>signed
up</type>
<label>24feb10 test2
form</label>
<url>http://content.bridgemailsystem.com/pms/preview/FormPreview.jsp?fID=jbMyddsw0Xx33jf</url>
</Event>
<Event>
<time>2011-11-03
11:41</time>
<type>campaign
sent</type>
<label>test2
campaign</label>
<url>http://content.bridgemailsystem.com/pms/preview/</url>
</Event>
<Event>
<time>2011-10-24 03:27</time>
<type>web visit</type>
<label>test wv
testing</label>
<pageTitle>BridgeMail WebVersion - test wv testing</pageTitle>
<url>http://content.bridgemailsystem.com/pms/events/webview.jsp?cnum=kzaqweee7Mj20Msdsb30kzaqw&snum=BzAEqwsJp20Gl2sdweRk33Sdsdj17Hn20Fk21BbgsFyh</url>
</Event>
</rsp>
Get Subscriber LeadScore
Method
Request URL
https://api.bridgemailsystem.com/pms/services/getleadscore/
XML Request
<?xml
version="1.0" encoding="ISO-8859-1" ?>
<subscriber>
<synchPartner>Netsuite</synchPartner>
<synchId>9999</synchId>
</subscriber>
Success Response
<?xml
version="1.0" encoding="ISO-8859-1"?>
<rsp status="ok">
<subscriber>
<synchPartner>Netsuite</synchPartner>
<synchId>9999</synchId>
<leadScore>320</leadScore>
</subscriber>
</rsp>
Create Trial Account Method
Request URL
https://api.bridgemailsystem.com/pms/services/createtrialaccount/
XML Request
<?xml version="1.0"
encoding="ISO-8859-1" ?>
<createtrial>
<email>user@test.com</email>
<userId>user@test.com</userId>
<passwd>test1234</passwd>
<company>test Company</company>
<companyUrl>www.test.com</companyUrl>
<addressLine1>park vally</addressLine1>
<addressLine2>zando
town</addressLine2>
<city>glacio</city>
<stateCode></stateCode>
<countryCode></countryCode>
<zip></zip>
<telephone>234323432</telephone>
<mobile>54545 454545445</mobile>
<title>CEO</title>
<logoUrl>www.test.com/logo.gif</logoUrl>
</createtrial>
Copyright © 2002 - 2011
Makesbridge Technologies, Inc. All rights reserved.