Skip to content

Update a search request
Customers

Request

Partially updates a search request for a customer. Requires SITE_CUSTOMER:WRITE permission.

Only provided fields are modified. Criteria are replaced entirely when provided (not merged with existing ones).

Security
bearerAuth
Path
customerIdintegerrequired

ID of the customer.

Example:789
searchRequestIdintegerrequired

ID of the search request to update.

Example:42
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 objects or null

Replacement criteria array. Same format as create. Replaces all existing criteria when provided.

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 PATCH \
  https://api-doc.immo-facile.com/_mock/openapi/customers/789/search-requests/42 \
  -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": "string",
        "operator": "CONTIENT",
        "value": null
      }
    ]
  }'

Responses

Search request updated

Response
No content