If you have your own system and would like to create an opt-in list 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.
- The API will create the list then it will response with the new list id and the keyword
- Url: https://mcpn.us/limeApi?ev=createOptinList
- 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 |
|
|
keyword |
Text |
Provide a custom keyword. Leave blank in order to create and use a random keyword |
|
|
programSponsor |
Text |
Program Sponsor |
|
|
briefDescription |
Text |
Brief Description |
|
|
shortcode |
Full short code (71441-US / 71441-Ca / 40691 / 60222 ...) |
Applicable only for accounts that having more than one short code. |
|
|
frequency |
Number |
The frequency number of messages values 1-15 |
4 |
|
frequencyPeriod |
Text |
The frequency period must be one of (month/day/week) |
month |
|
isDoubleOptIn |
true/false |
Indicate if double opt-in process required. Applicable only for US/Canada |
true |
|
customReplyYes |
Text |
Set a custom reply message. Leave blank to use the default |
Default message |
|
isProfileGraber |
true/false |
Indicate if profile grabber is enabled for this list. |
false |
|
sendToMyEmail |
true/false |
Indicate if send an email to your email address (on your profile) when a new lead is registered |
false |
|
notifyEmail |
|
Email address that will be notified when a new lead is registered |
none |
|
notifyNumber |
Mobile Number |
Mobile number/s address that will be notified when a new lead is registered, can be multiple numbers separated by a semicolon |
none |
|
couponId |
Number |
Coupon id that will be send after opt-in |
none |
|
couponSendTime |
Text |
When to send the coupon must be one of the values (Immediately/2 hours/24 hours/48 hours/72 hours/1 week) |
Immediately |
|
isCouponOneTime |
true/false |
Indicate if the coupon can be send multiple times or one time to users that opt-in again |
true |
|
alternativeAutoReply |
Text |
Auto reply message if the user try to opt-in to a list that he is already opted-in. |
|
|
responseUrl |
Text |
A url on your server that will be called upon action in the list. Please refer to the API document: "Opt-in List Keyword to Response URL" |
|
|
responseUrlMethod |
GET/POST |
Indicate the method of the response url must be GET/POST |
GET |
|
isResponseUrlNoMessage |
true/false |
Indicates if need to call the response url when a user already in the list |
false |
Return Code
- If the API succeeds then it will return with status code 200 with the following message: “Success - Opt-in List id: <List ID>, Keyword: <Keyword>"
- i.e. Success - Opt-in List id: 1452, Keyword: ad54 (71441-US)
- 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://mcpn.us/limeApi?ev=createOptinList&user=adv@gmail.com&api_id=hhXD73WrLV12552C&name=opt-in API&keyword=optAPI1&shortcode=71441-US&programSponsor=Giant%20Pizza&briefDescription=brieaf%20message&frequency=4&frequencyPeriod=month&isDoubleOptIn=false&isProfileGraber=false&couponId=3054&couponSendTime=2%20hours&isCouponOneTime=true&alternativeAutoReply=alternative%20message&sendToMyEmail=true¬ifyEmail=test@walla.com¬ifyNumber=15555555555&responseUrl=http://localhost/limeResponse&responseUrlMethod=POST&isResponseUrlNoMessage=true
Comments
0 comments
Article is closed for comments.