If you have your own system and would like to create a vehicle listing 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 a random keyword and create the list then it will response with the new list id and the new keyword
- Url: https://mcpn.us/limeApi?ev=createVehicleListing
- 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 |
|
|
year |
Vehicle's year |
Vehicle's year |
|
|
make |
Vehicle's make |
Vehicle's make |
|
|
model |
Vehicle's model |
Vehicle's model |
|
|
distance |
Vehicle's mileage |
Vehicle's mileage |
|
|
distanceUnit |
Miles/Km |
Use Miles/Km to set which unit is used in your country |
|
|
price |
Vehicle's price |
Vehicle's price |
|
|
other |
Other text |
Other text that describe the vehicle and will be added to the reply message |
|
|
couponId |
Number |
Coupon id that will be sent when user text to the list |
|
|
sendToMyEmail |
true/false |
Indicate if send an email to your email address (on your profile) when a new lead is registered |
|
|
notifyEmail |
|
Email address that will be notified when a new lead is registered |
|
|
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 |
|
|
targetOptIn |
Opt-in list Id |
Opt-in list id that opt-in the users when they text the keyword. If no list was chosen no opt-in will occur. |
|
|
country |
US/CA |
Applicable only for accounts that having both USA and Canada short codes. Use 'US' to create keyword on the US short code and Use 'CA' to create keyword on the Canadain short code |
|
|
adfEmail |
|
Email address that will be notified with ADF format when a new lead is registered |
Return Code
- If the API succeeds then it will return with status code 200 with the following message: “Success - Car List id: <List ID>, Keyword: <Keyword>"
- i.e. Success - Car List id: 419, Keyword: zd91 (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://login.limecellular.com/limeApi?ev=createVehicleListing&user=username&api_id=a4HI43WyFK83821B&name=Ford%20Explorer&year=2011&make=Ford&model=Explorer&distance=23000&distanceUnit=Miles&price=22,500&sendToMyEmail=true¬ifyEmail=example@gmail.com¬ifyNumber=15555555555&other=good%20condition&country=US
Comments
0 comments
Article is closed for comments.