If you have your own system and would like to get your opt-in lists or a specific list data without our dashboard, we have just created an API allowing you to do just that. This API is for server to server communication, in case you have your own CRM system or something similar to manage your customer base.
- Url: https://mcpn.us/limeApi?ev=optInLists
- You must supply one of the following parameters: listid / all
- Parameters (case sensitive, bold are mandatory):
|
Parameter Name (Case Sensitive)
|
Value |
Description |
Default Value |
|
user |
Advertiser username |
The advertiser’s username that matches the api_id |
None |
|
api_id |
Advertiser Api Id |
The advertiser’s api_id that matches the username |
Generated from edit profile |
|
name |
List name |
List name |
|
|
listid |
Number |
List Id |
The list id for lookup |
|
all |
true |
To get a list of all your listings |
|
Return Code
- If the API succeeds then it will return with status code 200 with xml
- If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.
- If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.
Example:
http://login.limecellular.com/limeApi?ev=optInLists&user=adv@gmail.com&api_id=a4HI43WyFK83821B&listid=398
XML:
If it's one listing lookup that is answer to the parameters: listid or keyword than the XML will be with one listing:
<?xml version="1.0" encoding="UTF-8"?>
<id>30</id>
<name>Demo Coupon - US</name>
<updateDate>06/21/2013</updateDate>
<keywords>pizza (71441-Ca), Pizza (71441-US)</keywords>
<programSponsor>Pizza Joe</programSponsor>
<brief>Special offers for loyal customers</brief>
<alternativeMessage>Thank you. You already registered</alternativeMessage>
<frequency>4</frequency>
<frequencyUnit>month</frequencyUnit>
<sendToMyEmail>false</sendToMyEmail>
<additionalEmail/><additionalMobile/>
<responseUrl/><responseUrlMethod/>
<isResponseOnExisting>false</isResponseOnExisting>
<isProfileGrabber>false</isProfileGrabber>
<couponId>9621</couponId>
<couponSendDelay>0</couponSendDelay>
<couponSendMultipleTimes>false</couponSendMultipleTimes>
<isDoubleOptIn>true</isDoubleOptIn>
<customReplyYes></customReplyYes>
</optInList>
If it's a group of listing lookup that is answer to the parameter: all than the XML will be with list of listing:
<?xml version="1.0" encoding="UTF-8" ?>
<?xml version="1.0" encoding="UTF-8"?>
<id>30</id>
<name>Demo</name>
<updateDate>06/21/2013</updateDate>
<keywords>pizza (71441-US)</keywords>
<programSponsor>Pizza Joe</programSponsor>
<brief>Special offers for loyal customers</brief>
<alternativeMessage>Thank you. You already registered</alternativeMessage>
<frequency>4</frequency>
<frequencyUnit>month</frequencyUnit>
<sendToMyEmail>false</sendToMyEmail>
<additionalEmail/><additionalMobile/>
<responseUrl/><responseUrlMethod/>
<isResponseOnExisting>false</isResponseOnExisting>
<isProfileGrabber>false</isProfileGrabber>
<couponId>1345</couponId>
<couponSendDelay>0</couponSendDelay>
<couponSendMultipleTimes>false</couponSendMultipleTimes>
<isDoubleOptIn>true</isDoubleOptIn>
<customReplyYes></customReplyYes>
</optInList>
<id>36</id>
<name>Coupons</name>
<updateDate>08/12/2012</updateDate>
<keywords>coupon (71441-Ca), coupon (71441-US)</keywords>
<programSponsor>Coupons</programSponsor>
<brief>Special offers for loyal customers</brief>
<alternativeMessage>Thank you. You already registered</alternativeMessage>
<frequency>2</frequency>
<frequencyUnit>week</frequencyUnit>
<sendToMyEmail>true</sendToMyEmail>
<additionalEmail/>15555555555<additionalMobile/>
<responseUrl/><responseUrlMethod/>
<isResponseOnExisting>false</isResponseOnExisting>
<isProfileGrabber>true</isProfileGrabber>
<couponId></couponId>
<couponSendDelay></couponSendDelay>
<couponSendMultipleTimes>false</couponSendMultipleTimes>
<isDoubleOptIn>false</isDoubleOptIn>
<customReplyYes></customReplyYes>
</optInList>
Comments
0 comments
Article is closed for comments.