Send Coupon API

Description:

This API allows you to use an application to send a coupon to a mobile number without having to log into the advertiser's dashboard. 

 

Url: https://mcpn.us/limeApi?ev=sendCoupon

  

Parameters

Parameter Name (Case Sensitive)	Value	Description	Remarks
user  (mandatory)	Advertiser username	The advertiser’s username that matches the api_id
api_id (mandatory)	Advertiser Api Id	The advertiser’s api_id that matches the username	Can be generated from the advertiser's profile. Click on "Edit Profile."
id (mandatory)	Coupon ID	The coupon ID that needs to send
mN (mandatory)	Mobile Number	Mobile Number to send
first (optional)	First name	The mobile number’s owner first name
last (optional)	Last name	The mobile number’s owner last name
gender (optional)	M or F	The mobile number’s owner gender
email (optional)	Email address	The mobile number’s owner email
birthday (optional)	Birth Day 1-31	The mobile number’s owner birthday
birthmonth (optional)	Birth Month 1-12	The mobile number’s owner birth month
birthyear (optional)	Birth Year	The mobile number’s owner birth year
zip (optional)	Zip Code	The mobile number’s owner zip code
userDefine1	String	Value of the first custom field	Will be added to the user only if custom fields have been configured
userDefine2	String	Value of the second custom field	Will be added to the user only if custom fields have been configured
userDefine3	String	Value of the third custom field	Will be added to the user only if custom fields have been configured
userDefine4	String	Value of the fourth custom field	Will be added to the user only if custom fields have been configured
userDefine5	String	Value of the fifth custom field	Will be added to the user only if custom fields have been configured
userDefine6day	Number	Day section of custom field 6. (Values 1-31)
userDefine6month	Number	Month section of custom field 6. (Values 0-11)
userDefine6year	Number	Year section of custom field 6. (Value YYYY)
userDefine7day	Number	Day section of custom field 7. (Values 1-31)
userDefine7month	Number	Month section of custom field 7. (Values 0-11)
userDefine7year	Number	Year section of custom field 7. (Value YYYY)
format	Xml/json	Optional for sending the parameters as xml file or json. If present then only values from XML/JSON will be used.
isJson	true/false	Set to true if need response in JSON format	Default is false

 

Return Code

If the API succeeds, then it will return with status code 200.

 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 optional parameter is invalid than the system will ignore this parameter and the API continue as it was not supplied.

 

Example:

https://mcpn.us/limeApi?ev=sendCoupon&user=advertiser@gmpizza.com&api_id=q5JA73WRLy13822c&id=123456&mN=15555555555

  

Example for XML:

https://mcpn.us/limeApi?ev=sendCoupon&format=xml

 

XML File:

<?xml version="1.0" ?>

<Data>

            <User>user</User>

            <ApiId>api key</ApiId>

            <Id>ID</Id>

            <Mobile>Mobile</Mobile>

            <FirstName>FirstName</FirstName>

            <LastName>LastName</LastName>

            <Gender>Gender</Gender>

            <Email>Email</Email>

            <BirthDate>yyyy-MM-dd'T'HH:mm:ss'Z'</BirthDate>

            <ZipCode>ZipCode</ZipCode>     

<UserDefine1>UserDefine1</UserDefine1>

            <UserDefine2>UserDefine2</UserDefine2>

            <UserDefine3>UserDefine3</UserDefine3>

            <UserDefine4>UserDefine4</UserDefine4>

            <UserDefine5>UserDefine5</UserDefine5>

            <UserDefine6>yyyy-MM-dd'T'HH:mm:ss'Z'</UserDefine6>

            <UserDefine7>yyyy-MM-dd'T'HH:mm:ss'Z'</UserDefine7>

<IsJson>true</IsJson>

</Data>

 

 

Example for JSON:

https://mcpn.us/limeApi?ev=sendCoupon&format=json

 

JSON File:

{

            "user": "user",

            "apiId": "apiId",

            "id": "id",

"mobile": "mobile",

            "firstName": "firstName",

            "lastName": "lastName",

            "gender": "gender",

            "email": "email",

            "birthDate": "yyyy-MM-dd'T'HH:mm:ss'Z'",

            "zipCode": "zipCode",      

            "userDefine1": "userDefine1",

            "userDefine2": "userDefine1",

            "userDefine3": "userDefine1",

            "userDefine4": "userDefine1",

            "userDefine5": "userDefine1",

            "userDefine6": "yyyy-MM-dd'T'HH:mm:ss'Z'",

            "userDefine7": "yyyy-MM-dd'T'HH:mm:ss'Z'",

            "isJson": "true/false"

}