⚠️ **Important Notice: Legacy API - Deprecated**
This API is now considered legacy and has been deprecated. It will continue functioning, but no future updates will be made. We recommend that you transition to the latest API to ensure compatibility and continued support. If you would like more information on the newest version, please don't hesitate to contact our support.
PROPERTY LEADS
POST [ https://insert.moonshapes.pt/lead ]
The below table provides a listing of possible fields and a description of their usage. Some fields have restricted answer values;
| Field name | Data type | Description | Enum | Default | Required |
| Token | String | Unique Proppy Token | Yes | ||
| PropertyID | Number | Unique Proppy ProppyID | Yes | ||
| CustomerOriginID | Number | Unique Proppy CustomerOriginID | Yes | ||
| EntityName | String | Entity name | "" | No | |
| EntityEmail | String | Entity email | "" | No | |
| EntityPhone | String | Entity phone | "" | No | |
| Message | String | Description of the event. | "" | No | |
| CreateProfile | Boolean | This option will create an entity profile | false | No | |
| EntityCulture | String | This option sets the entity language; | ["pt", "en", "es", "fr", "it", "de", "nl", "se", "dk", "no", "pl", "cn", "ru", "fi", "ar"] | "pt" | No |
| EntityType | String | this option sets the entity type | ["sale", "rent"] | "sale" | No |
| AssignBrokerIDFromProperty | Boolean | it will assign the property broker to the entity. | false | No | |
| AutoAssociateCurrentBuyerBroker | Boolean | If the customer already exists, it will be assigned to the same broker | false | No | |
| FromBedrooms | Number | Profile value | 0 | No | |
| ToBedrooms | Number | Profile value | 0 | No | |
| PriceFrom | Number | Profile value | 0 | No | |
| PriceTo | Number | Profile value | 0 | No | |
| PropertyType | String | Profile value | ["Allotment", "Apartment", "Apartment with pool", "Apartment with shared pool", "Bed & Breakfast", "Bedroom w/ private bathroom", "Building", "Bungalow", "Business", "Castle", "Comercial / Shop", "Commercial property", "Complex", "Cottage", "Country house", "Countryside villa", "Detached house", "Development", "Duplex apartment", "Duplex Villa", "Equestrian", "Farm", "Farm land", "Farmhouse", "Garage", "Guest house / B+B", "Historical villa", "Holiday lettings", "Hotel", "Hotel or B/B", "Hotels/Guest Houses and Rural Tourism ", "Investment", "Land", "Land for urban development", "Land project", "Loft", "Long term rentals", "Luxury property", "Mill", "Off plan project", "Office", "Old house", "Others", "Parking", "Penthouse", "Plot", "Plot with ruin", "Plots & Ruins", "Quartershares", "Residencial", "Resort", "Restaurant / snack", "Restaurants / Bars / Shops ", "Room", "Ruin", "Rural house", "Rural land", "Rustic land & farmhouses", "Semi-detached", "Short time rent", "Studio", "Studio with shared pool", "Terraced house", "Touristic complex", "Townhouse", "Townhouse / Semi-detached", "Townhouse with shared pool", "Townhouses /villas", "Urban land", "Urbanised building plots", "Urbanization", "Villa", "Villa + annex(es)", "Villa floor", "Villa to be renovated", "Villa with pool", "Villa with shared pool", "Warehouse"] | "" | No |
| Zone | String | Profile value | "" | No | |
| FromBathrooms | Number | Profile value | 0 | No | |
| ToBathrooms | Number | Profile value | 0 | No | |
| Subject | String | Event title | "" | No | |
| CountryISO | string | Will add the clients country iso into his profile | "" | No | |
| IncludeMailing | Boolean | This option will allow the new contact to accept any future newsletter | false | No | |
| IncludeOptIn | Boolean | This option will allow the new contact to be contacted | false | No |
Request example
<?php $params = array( 'Token' => '<token>', 'PropertyID' => <propertyID>, 'CustomerOriginID' => <customerOriginID>, 'EntityName' => 'Yoshiaki Nakamura', 'EntityEmail' => 'Yoshiaki.Nakamura@narutokawai.com', 'EntityPhone' => '293 000 000', 'Message' => 'Hello, world!', 'CreateProfile' => true, 'EntityCulture' => 'pt', 'EntityType' => 'sale', 'AssignBrokerIDFromProperty' => false, 'AutoAssociateCurrentBuyerBroker' => false ); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://insert.moonshapes.pt/lead'); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params)); $result = curl_exec($ch); curl_close($ch); print_r($result); ?>
Response example
{
"status": true,
"message": "Record Inserted Successfully!"
}