PUT
/
searches
/
{id}
curl --location --request POST 'https://api.notif.immo/searches/{id}' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api_key>' \
--data-raw '{
  "bedroomMin": 0,
  "budgetMax": 0,
  "budgetMin": 0,
  "endpointRecipient": "https://www.mycompany.com/webhook_melo_match",
  "eventEndpoint": "https://www.mycompany.com/webhook_melo_updates",
  "excludedCities": [
    "string"
  ],
  "excludedSiteCategories": [
    "string"
  ],
  "expressions": "expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=true&expressions[1][0][word]=viager&expressions[1][0][options][includes]=true&expressions[1][0][options][strict]=true",
  "furnished": true,
  "hidePropertyContact": true,
  "includedCities": [
    "string"
  ],
  "includedDepartments": [
    "string"
  ],
  "includedSiteCategories": [
    "string"
  ],
  "landSurfaceMax": 0,
  "landSurfaceMin": 0,
  "lat": "48.864716",
  "lon": "2.349014",
  "notificationEnabled": false,
  "notificationRecipient": "foo@bar.com",
  "pricePerMeterMax": 0,
  "pricePerMeterMin": 0,
  "propertyTypes": 3,
  "publisherTypes": 3,
  "radius": "20",
  "roomMin": 0,
  "subscribedEvents": [
    "ad.update.price"
  ],
  "surfaceMax": 0,
  "surfaceMin": 0,
  "title": "string",
  "transactionType": "0",
  "withCoherentPrice": true,
  "withVirtualTour": true
}'
{
  "bedroomMin": 0,
  "budgetMax": 0,
  "budgetMin": 0,
  "endpointRecipient": "https://www.mycompany.com/webhook_melo_match",
  "eventEndpoint": "https://www.mycompany.com/webhook_melo_updates",
  "excludedCities": [
    "string"
  ],
  "excludedSiteCategories": [
    "string"
  ],
  "expressions": "expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=true&expressions[1][0][word]=viager&expressions[1][0][options][includes]=true&expressions[1][0][options][strict]=true",
  "furnished": true,
  "hidePropertyContact": true,
  "includedCities": [
    "string"
  ],
  "includedDepartments": [
    "string"
  ],
  "includedSiteCategories": [
    "string"
  ],
  "landSurfaceMax": 0,
  "landSurfaceMin": 0,
  "lat": "48.864716",
  "lon": "2.349014",
  "notificationEnabled": false,
  "notificationRecipient": "foo@bar.com",
  "pricePerMeterMax": 0,
  "pricePerMeterMin": 0,
  "propertyTypes": 3,
  "publisherTypes": 3,
  "radius": "20",
  "roomMin": 0,
  "subscribedEvents": [
    "ad.update.price"
  ],
  "surfaceMax": 0,
  "surfaceMin": 0,
  "title": "string",
  "transactionType": "0",
  "withCoherentPrice": true,
  "withVirtualTour": true
}

Path

id
string
required
UUID of the existing search

Body

bedroomMin
integer
Minimum number of bedrooms in the property.
bedroomMin
integer
Minimum number of bedrooms in the property.
budgetMax
integer
Maximum budget for the property.
budgetMin
integer
Minimum budget for the property.
endpointRecipient
string
Endpoint webhook to receive new matches in real time. Https url is required. You can test your endpoint here using our webhhok simulator.
eventEndpoint
string
Endpoint webhook to receive adverts events in real time. Https url is required. You can test your endpoint using our webhhok simulator
excludedCities
array
Cities to be excluded.
excludedSiteCategories
array
Site categories to be excluded.
expressions
array
Full text matching including/excluding words & phrases in the title or the description of the property. Example: expressions[0][0][word]=travaux&expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=false&expressions[0][1][word]=lumineux&expressions[0][1][options][includes]=true&expressions[0][1][options][strict]=false which will search for properties that contain both the keywords lumineux and travaux.
furnished
boolean
Whether the property is furnished or not.
hidePropertyContact
boolean
Whether to hide property contact information or not.
includedCities
array
Included cities.
includedDepartments
array
Included departments.
includedSiteCategories
array
Included site categories.
landSurfaceMax
integer
Maximum land surface.
landSurfaceMin
integer
Minimum land surface.
lat
number
Latitude. Will work if latitude exists in the property. Example: lat=48.864716
lon
number
Longitude. Will work if latitude exists in the property. Example: lon=2.349014
notificationEnabled
boolean
default:"false"
Enable notifications which can be webhooks or emails.
pricePerMeterMax
integer
Maximum price per meter.
pricePerMeterMin
integer
Minimum price per meter.
propertyTypes
integer
required
Type of property. Apartment 0, House 1, Building 2, Parking 3, Office 4, Land 5, Shop 6. Example: propertyTypes[]=0&propertyTypes[]=1
publisherTypes
integer
Type of publisher. Individual 0, Professional 1. Example: publisherTypes[]=0&publisherTypes[]=1
radius
integer
Distance expressed in kilometers. Will work if latitude & longitude exist in the property. Example: radius=20
roomMin
integer
Minimum number of rooms.
roomMax
integer
Maximum number of rooms.
subscribedEvents
array
Events you want to be alerted which will be sent to the eventEndpoint.
surfaceMax
integer
Maximum property surface area.
surfaceMin
integer
Minimum property surface area.
title
string
required
Title of the created search.
transactionType
integer
required
Type of transaction. Sell 0, Rent 1. Example: transactionType=0
withCoherentPrice
boolean
default:"true"
Having properties with coherent prices.
withVirtualTour
boolean
Whether the property includes a virtual tour.
curl --location --request POST 'https://api.notif.immo/searches/{id}' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api_key>' \
--data-raw '{
  "bedroomMin": 0,
  "budgetMax": 0,
  "budgetMin": 0,
  "endpointRecipient": "https://www.mycompany.com/webhook_melo_match",
  "eventEndpoint": "https://www.mycompany.com/webhook_melo_updates",
  "excludedCities": [
    "string"
  ],
  "excludedSiteCategories": [
    "string"
  ],
  "expressions": "expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=true&expressions[1][0][word]=viager&expressions[1][0][options][includes]=true&expressions[1][0][options][strict]=true",
  "furnished": true,
  "hidePropertyContact": true,
  "includedCities": [
    "string"
  ],
  "includedDepartments": [
    "string"
  ],
  "includedSiteCategories": [
    "string"
  ],
  "landSurfaceMax": 0,
  "landSurfaceMin": 0,
  "lat": "48.864716",
  "lon": "2.349014",
  "notificationEnabled": false,
  "notificationRecipient": "foo@bar.com",
  "pricePerMeterMax": 0,
  "pricePerMeterMin": 0,
  "propertyTypes": 3,
  "publisherTypes": 3,
  "radius": "20",
  "roomMin": 0,
  "subscribedEvents": [
    "ad.update.price"
  ],
  "surfaceMax": 0,
  "surfaceMin": 0,
  "title": "string",
  "transactionType": "0",
  "withCoherentPrice": true,
  "withVirtualTour": true
}'
{
  "bedroomMin": 0,
  "budgetMax": 0,
  "budgetMin": 0,
  "endpointRecipient": "https://www.mycompany.com/webhook_melo_match",
  "eventEndpoint": "https://www.mycompany.com/webhook_melo_updates",
  "excludedCities": [
    "string"
  ],
  "excludedSiteCategories": [
    "string"
  ],
  "expressions": "expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=true&expressions[1][0][word]=viager&expressions[1][0][options][includes]=true&expressions[1][0][options][strict]=true",
  "furnished": true,
  "hidePropertyContact": true,
  "includedCities": [
    "string"
  ],
  "includedDepartments": [
    "string"
  ],
  "includedSiteCategories": [
    "string"
  ],
  "landSurfaceMax": 0,
  "landSurfaceMin": 0,
  "lat": "48.864716",
  "lon": "2.349014",
  "notificationEnabled": false,
  "notificationRecipient": "foo@bar.com",
  "pricePerMeterMax": 0,
  "pricePerMeterMin": 0,
  "propertyTypes": 3,
  "publisherTypes": 3,
  "radius": "20",
  "roomMin": 0,
  "subscribedEvents": [
    "ad.update.price"
  ],
  "surfaceMax": 0,
  "surfaceMin": 0,
  "title": "string",
  "transactionType": "0",
  "withCoherentPrice": true,
  "withVirtualTour": true
}