Create a new Advert alert for this search
Create a new Advert alert for this search
Create a new alert on a Advert search. The alert will be saved in the database and will be triggered when a new Advert is found.
PUT
/
v2
/
protected
/
adverts
/
search
/
alerts
curl --request PUT \
--url https://api.fluximmo.io/v2/protected/adverts/search/alerts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"search_query": {
"filterAd": {
"currentPrice": {
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"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
}
},
"hasAnomaly": true,
"isAuction": true,
"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
},
"lastModifiedAt": [
{
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
],
"offer": [
{
"isCurrentlyOccupied": true,
"renting": {
"isColocation": true,
"isLongTerm": true,
"isShortTerm": true,
"isSubLease": true
},
"type": "OFFER_BUY"
}
],
"parking": {
"count": {
"max": 123,
"min": 123
},
"numberOfCars": {
"max": 123,
"min": 123
},
"surface": {
"max": 123,
"min": 123
},
"type": []
},
"process": [],
"scope": [],
"tags": [
"<string>"
],
"type": [
"CLASS_HOUSE"
],
"warrantyDeposit": {
"max": 123,
"min": 123
},
"firstSeenAt": [
{
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
],
"location": {
"city": "<string>",
"cityCoordinate": {
"location": {
"geoBoundingBox": {
"bottomRight": {
"lat": 123,
"lon": 123
},
"topLeft": {
"lat": 123,
"lon": 123
}
},
"geoDistance": {
"distanceKm": 123,
"pin": {
"lat": 123,
"lon": 123
}
},
"geoInseeCodeDistance": {
"distanceKm": 123,
"inseeCode": "<string>"
}
}
},
"department": "<string>",
"inseeCode": "<string>",
"irisCode": "<string>",
"locationCoordinate": {
"location": {
"geoBoundingBox": {
"bottomRight": {
"lat": 123,
"lon": 123
},
"topLeft": {
"lat": 123,
"lon": 123
}
},
"geoDistance": {
"distanceKm": 123,
"pin": {
"lat": 123,
"lon": 123
}
},
"geoInseeCodeDistance": {
"distanceKm": 123,
"inseeCode": "<string>"
}
}
},
"postalCode": "<string>"
},
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"currency": [],
"mainPropertyAdFlxId": [
"<string>"
],
"propertyFlxId": [
"<string>"
],
"isPro": true,
"seller": [],
"isOnline": true,
"isExclusive": true
},
"fullTexts": [
"<string>"
],
"keywords": [
"<string>"
]
},
"webhook_url": "<string>",
"search_name": "<string>",
"context": {
"metadata": {}
},
"match": [
"ALERT_MATCH_CREATED"
]
}'
{
"data": {
"alert_id": "<string>"
}
}
Authorizations
Body
application/json
Response
200
application/json
The response is of type object
.
Was this page helpful?
curl --request PUT \
--url https://api.fluximmo.io/v2/protected/adverts/search/alerts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"search_query": {
"filterAd": {
"currentPrice": {
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"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
}
},
"hasAnomaly": true,
"isAuction": true,
"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
},
"lastModifiedAt": [
{
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
],
"offer": [
{
"isCurrentlyOccupied": true,
"renting": {
"isColocation": true,
"isLongTerm": true,
"isShortTerm": true,
"isSubLease": true
},
"type": "OFFER_BUY"
}
],
"parking": {
"count": {
"max": 123,
"min": 123
},
"numberOfCars": {
"max": 123,
"min": 123
},
"surface": {
"max": 123,
"min": 123
},
"type": []
},
"process": [],
"scope": [],
"tags": [
"<string>"
],
"type": [
"CLASS_HOUSE"
],
"warrantyDeposit": {
"max": 123,
"min": 123
},
"firstSeenAt": [
{
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
],
"location": {
"city": "<string>",
"cityCoordinate": {
"location": {
"geoBoundingBox": {
"bottomRight": {
"lat": 123,
"lon": 123
},
"topLeft": {
"lat": 123,
"lon": 123
}
},
"geoDistance": {
"distanceKm": 123,
"pin": {
"lat": 123,
"lon": 123
}
},
"geoInseeCodeDistance": {
"distanceKm": 123,
"inseeCode": "<string>"
}
}
},
"department": "<string>",
"inseeCode": "<string>",
"irisCode": "<string>",
"locationCoordinate": {
"location": {
"geoBoundingBox": {
"bottomRight": {
"lat": 123,
"lon": 123
},
"topLeft": {
"lat": 123,
"lon": 123
}
},
"geoDistance": {
"distanceKm": 123,
"pin": {
"lat": 123,
"lon": 123
}
},
"geoInseeCodeDistance": {
"distanceKm": 123,
"inseeCode": "<string>"
}
}
},
"postalCode": "<string>"
},
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"currency": [],
"mainPropertyAdFlxId": [
"<string>"
],
"propertyFlxId": [
"<string>"
],
"isPro": true,
"seller": [],
"isOnline": true,
"isExclusive": true
},
"fullTexts": [
"<string>"
],
"keywords": [
"<string>"
]
},
"webhook_url": "<string>",
"search_name": "<string>",
"context": {
"metadata": {}
},
"match": [
"ALERT_MATCH_CREATED"
]
}'
{
"data": {
"alert_id": "<string>"
}
}