Skip to content

Create a search request
Customers

Request

Creates a search request for a customer with criteria. Requires SITE_CUSTOMER:WRITE permission.

Search requests define what a buyer/tenant is looking for. When active, the system runs automatic matching against new property listings.

Security
bearerAuth
Path
customerIdintegerrequired

ID of the customer to attach the search request to.

Example:789
Bodyapplication/jsonrequired
namestring or null

Label for the search request.

Example:"Apartment T3 Paris 15 budget 400k"
commentstring or null

Internal note about this search request.

Example:"Client flexible on surface, priority is location near metro"
is_activeboolean or null

Whether the search request is active.

Example:true
has_email_alertboolean or null

Send email alerts when matching properties are found.

Example:true
has_sms_alertboolean or null

Send SMS alerts when matching properties are found.

Example:false
intended_use_idinteger or null

Intended use.

reason_for_purchase_idinteger or null

Reason-for-purchase list value ID (liste 35).

current_resale_idinteger or null

Current-resale list value ID (liste 77).

timeframe_idinteger or null

Timeframe list value ID (liste 4).

criteriaArray of objectsrequired

Array of search criteria. Each criterion has an id, an operator, and a value.

Operators:

OperatorDescriptionExample use
EGALEquals (exact match)Transaction type, property category
SUPERIEURGreater than or equalMin surface, min rooms
INFERIEURLess than or equalMax price, max floor
CONTIENTContains (multi-value)Zones, cities
DIFFERENTNot equalExclude a type

Common criteria IDs (use GET /criterias/search-requests for the full list):

IDDescriptionType
27Property categoryUNIQUE
28Transaction typeUNIQUE
65Postcode CityTEXT
30PriceNUMBER
33Number of roomsNUMBER
34Living area (m²)NUMBER
38BedroomsNUMBER
Example:
[
  {
    "id": "27",
    "operator": "EGAL",
    "value": "1"
  },
  {
    "id": "28",
    "operator": "EGAL",
    "value": "Vente"
  },
  {
    "id": "30",
    "operator": "INFERIEUR",
    "value": "400000"
  },
  {
    "id": "33",
    "operator": "EGAL",
    "value": "3"
  },
  {
    "id": "65",
    "operator": "EGAL",
    "value": "75015 PARIS"
  }
]
keywordstring or nulldeprecated
wordingstring or nulldeprecated

Deprecated. Use name.

alertEmailboolean or nulldeprecated

Deprecated. Use has_email_alert.

alertSmsboolean or nulldeprecated

Deprecated. Use has_sms_alert.

curl -i -X POST \
  https://api-doc.immo-facile.com/_mock/openapi/customers/789/search-requests \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Apartment T3 Paris 15 budget 400k",
    "comment": "Client flexible on surface, priority is location near metro",
    "is_active": true,
    "has_email_alert": true,
    "has_sms_alert": false,
    "intended_use_id": 0,
    "reason_for_purchase_id": 0,
    "current_resale_id": 0,
    "timeframe_id": 0,
    "keyword": "string",
    "wording": "string",
    "alertEmail": true,
    "alertSms": true,
    "criteria": [
      {
        "id": "27",
        "operator": "EGAL",
        "value": "1"
      },
      {
        "id": "28",
        "operator": "EGAL",
        "value": "Vente"
      },
      {
        "id": "30",
        "operator": "INFERIEUR",
        "value": "400000"
      },
      {
        "id": "33",
        "operator": "EGAL",
        "value": "3"
      },
      {
        "id": "65",
        "operator": "EGAL",
        "value": "75015 PARIS"
      }
    ]
  }'

Responses

Search request created

Bodyapplication/json
dataobject
Response
{
  "data": {
    "id": 42
  }
}