Properties Alerts
Create a new alert for this Property search
System
- System
Properties
- Samples
- Properties
- Reporting
- Properties Alerts
- PUTCreate a new alert for this Property search
- GETGet the search criteria of a Propertyalert
- DELDeactivate a Property search alert
- PATCHUpdate the search criteria of a Property alert
- GETGet all your Property alerts
- GETActivate a Property search alert
- GETGet history of match properties by its saved search flxId
- PUT
Adverts
- Samples
- Reporting
- Adverts
- Adverts Alerts
RealEstate Companies
- Agency details
Properties Alerts
Create a new alert for this Property search
Create a new alert on a Property search. The alert will be saved in the database and will be triggered when a new property is found.
PUT
/
v2
/
protected
/
properties
/
search
/
alerts
curl --request PUT \
--url https://api.fluximmo.io/v2/protected/properties/search/alerts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"search_query": {
"filterProperty": {
"adverts": [],
"habitation": {
"bathroomCount": {
"max": 123,
"min": 123
},
"bedroomCount": {
"max": 123,
"min": 123
},
"characteristics": {
"hasAlarm": true,
"hasBalcony": true,
"hasCellar": true,
"hasConcierge": true,
"hasDigicode": true,
"hasFireplace": true,
"hasGarage": true,
"hasGarden": true,
"hasGrenier": true,
"hasInterphone": true,
"hasJacuzzi": true,
"hasLand": true,
"hasLift": true,
"hasMezzanine": true,
"hasParking": true,
"hasPool": true,
"hasTerrace": true,
"hasVisAVis": true,
"isPeaceful": true
},
"climate": {
"epcClimate": [],
"epcClimateScore": {
"max": 123,
"min": 123
},
"epcEnergy": [],
"epcEnergyScore": {
"max": 123,
"min": 123
},
"epcClimateDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"epcEnergyDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"features": {
"exposure": [],
"furniture": [],
"propertyFloor": {
"max": 123,
"min": 123
},
"propertyTotalFloor": {
"max": 123,
"min": 123
},
"constructionMaterials": [],
"glazingTypes": [],
"hasThroughExposure": true,
"viewOns": [],
"viewTypes": []
},
"heatTypes": [],
"heatTypeDetails": [],
"heatings": [],
"propertyCondition": [
{
"constructionYear": 123,
"interiorCondition": null,
"renovationYear": 123,
"generalConditions": []
}
],
"roomCount": {
"max": 123,
"min": 123
},
"surface": {
"balconies": {
"max": 123,
"min": 123
},
"floorSpace": {
"max": 123,
"min": 123
},
"gardens": {
"max": 123,
"min": 123
},
"groundFloor": {
"max": 123,
"min": 123
},
"kitchen": {
"max": 123,
"min": 123
},
"livingSpace": {
"max": 123,
"min": 123
},
"livingroom": {
"max": 123,
"min": 123
},
"terraces": {
"max": 123,
"min": 123
},
"total": {
"max": 123,
"min": 123
}
},
"type": "PROPERTY_TYPE_T1_T2",
"wcCount": {
"max": 123,
"min": 123
}
},
"isUrgent": true,
"land": {
"canConstruct": true,
"isServiced": true,
"surface": {
"max": 123,
"min": 123
},
"surfaceConstructable": {
"max": 123,
"min": 123
},
"type": [],
"haveBuildingPermit": true,
"haveElectricity": true,
"haveTelecom": true,
"haveWater": true
},
"location": [],
"meta": {
"firstSeenAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"isTotallyOffline": true,
"lastPublishedAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"lastSeenAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"lastUpdatedAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"parking": {
"count": {
"max": 123,
"min": 123
},
"numberOfCars": {
"max": 123,
"min": 123
},
"surface": {
"max": 123,
"min": 123
},
"type": []
},
"price": {
"currency": [],
"initial": {
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"isAuction": true,
"latest": {
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"scope": [],
"warrantyDeposit": {
"max": 123,
"min": 123
},
"variation": []
},
"process": [],
"tags": [
"<string>"
],
"type": [
"CLASS_HOUSE"
],
"hasAnomaly": true,
"offer": []
},
"fullTexts": [
"<string>"
],
"keywords": [
"<string>"
]
},
"webhook_url": "<string>",
"search_name": "<string>",
"match": [
"ALERT_MATCH_CREATED"
],
"context": {
"metadata": {}
}
}'
{
"data": {
"alert_id": "<string>"
}
}
Authorizations
Body
application/json
Response
200
application/json
The response is of type object
.
curl --request PUT \
--url https://api.fluximmo.io/v2/protected/properties/search/alerts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"search_query": {
"filterProperty": {
"adverts": [],
"habitation": {
"bathroomCount": {
"max": 123,
"min": 123
},
"bedroomCount": {
"max": 123,
"min": 123
},
"characteristics": {
"hasAlarm": true,
"hasBalcony": true,
"hasCellar": true,
"hasConcierge": true,
"hasDigicode": true,
"hasFireplace": true,
"hasGarage": true,
"hasGarden": true,
"hasGrenier": true,
"hasInterphone": true,
"hasJacuzzi": true,
"hasLand": true,
"hasLift": true,
"hasMezzanine": true,
"hasParking": true,
"hasPool": true,
"hasTerrace": true,
"hasVisAVis": true,
"isPeaceful": true
},
"climate": {
"epcClimate": [],
"epcClimateScore": {
"max": 123,
"min": 123
},
"epcEnergy": [],
"epcEnergyScore": {
"max": 123,
"min": 123
},
"epcClimateDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"epcEnergyDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"features": {
"exposure": [],
"furniture": [],
"propertyFloor": {
"max": 123,
"min": 123
},
"propertyTotalFloor": {
"max": 123,
"min": 123
},
"constructionMaterials": [],
"glazingTypes": [],
"hasThroughExposure": true,
"viewOns": [],
"viewTypes": []
},
"heatTypes": [],
"heatTypeDetails": [],
"heatings": [],
"propertyCondition": [
{
"constructionYear": 123,
"interiorCondition": null,
"renovationYear": 123,
"generalConditions": []
}
],
"roomCount": {
"max": 123,
"min": 123
},
"surface": {
"balconies": {
"max": 123,
"min": 123
},
"floorSpace": {
"max": 123,
"min": 123
},
"gardens": {
"max": 123,
"min": 123
},
"groundFloor": {
"max": 123,
"min": 123
},
"kitchen": {
"max": 123,
"min": 123
},
"livingSpace": {
"max": 123,
"min": 123
},
"livingroom": {
"max": 123,
"min": 123
},
"terraces": {
"max": 123,
"min": 123
},
"total": {
"max": 123,
"min": 123
}
},
"type": "PROPERTY_TYPE_T1_T2",
"wcCount": {
"max": 123,
"min": 123
}
},
"isUrgent": true,
"land": {
"canConstruct": true,
"isServiced": true,
"surface": {
"max": 123,
"min": 123
},
"surfaceConstructable": {
"max": 123,
"min": 123
},
"type": [],
"haveBuildingPermit": true,
"haveElectricity": true,
"haveTelecom": true,
"haveWater": true
},
"location": [],
"meta": {
"firstSeenAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"isTotallyOffline": true,
"lastPublishedAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"lastSeenAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"lastUpdatedAt": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"parking": {
"count": {
"max": 123,
"min": 123
},
"numberOfCars": {
"max": 123,
"min": 123
},
"surface": {
"max": 123,
"min": 123
},
"type": []
},
"price": {
"currency": [],
"initial": {
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"isAuction": true,
"latest": {
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"scope": [],
"warrantyDeposit": {
"max": 123,
"min": 123
},
"variation": []
},
"process": [],
"tags": [
"<string>"
],
"type": [
"CLASS_HOUSE"
],
"hasAnomaly": true,
"offer": []
},
"fullTexts": [
"<string>"
],
"keywords": [
"<string>"
]
},
"webhook_url": "<string>",
"search_name": "<string>",
"match": [
"ALERT_MATCH_CREATED"
],
"context": {
"metadata": {}
}
}'
{
"data": {
"alert_id": "<string>"
}
}