If you have your own system and would like to edit a property 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.
- This API will edit each value of the listing. If the value not supplied by the API then it will be changed to null (empty) value.
- Url: https://mcpn.us/limeApi?ev=updatePropertyListing
- 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 that need to update |
address |
Property's Address |
Property's Address |
|
bed |
Number |
Number of beds (Values need to be like the allowed values in the UI) |
|
bath |
Number |
Number of baths (Values need to be like the allowed values in the UI) |
|
description |
Text |
Property's description |
|
price |
Property's price |
Property's price |
|
url |
Property's url |
A url that will be shorten and will be sent as a response |
|
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. |
|
shortcode |
Full short code (71441-US / 71441-Ca / 40691 / 60222 ...) |
Applicable only for accounts that having both more than one. |
|
Return Code
- If the API succeeds then it will return with status code 200 with the following message: “Success"
- 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=updatePropertyListing&user=username&api_id=a4HI43WyFK83821B&listid=101&name=House%20130&address=13%20amin%20St.%20New%20York%20NY%2010121&price=$200,000&bed=4&bath=2&description=Great%20conditionmust%20see&sendToMyEmail=true¬ifyEmail=example@gmail.com¬ifyNumber=15555555555&shortcode=71441-US
Comments
0 comments
Article is closed for comments.