Update alert
Update an existing alert. Only the fields present in the body change: omit a field to keep its stored value, or send a nullable field as null to clear it. Same criteria tree shape as POST. Any update that would leave the alert enabled with no destination of its own returns 422 when your account has no default destination, whether or not the update is what enabled it. Sending notificationDestination as null returns 422 whenever your account has no default destination, for a disabled alert too.
Authorization
apiKey Value for the X-API-KEY header parameter.
In: header
Path Parameters
Alert identifier
Request Body
application/json
The updated Alert resource
Response Body
curl -X PUT "https://example.com/alerts/3fa85f64-5717-4562-b3fc-2c963f66afa6" \ -H "Content-Type: application/json" \ -d '{ "name": "2-bedroom rentals in Paris under €2,000/month", "enabled": true, "criteria": { "property": { "type": { "in": [ "FLAT" ] }, "transaction": { "type": "RENT" }, "pricing": { "displayed": { "lte": 2000 } }, "locations": { "countryCode": "FR", "in": { "uniqueCodes": [ "75056" ] } }, "unit": { "bedrooms": { "gte": 2 } } } }, "notificationConfig": { "rules": [ { "eventType": "NEW_MATCH" }, { "eventType": "PRICE_CHANGE", "variationPercent": [ { "lte": -5 }, { "gte": 5 } ] } ] } }'{ "name": "2-bedroom apartments in Paris", "enabled": true, "criteria": { "and": [ { "property": { "type": { "in": [ "FLAT", "HOUSE" ] }, "transaction": { "type": "SELL" }, "pricing": { "displayed": { "gte": 200000, "lte": 450000 } }, "unit": { "bedrooms": { "gte": 2 } } } }, { "or": [ { "property": { "locations": { "countryCode": "FR", "in": { "uniqueCodes": [ "75056" ] } } } }, { "property": { "locations": { "countryCode": "FR", "in": { "uniqueCodes": [ "69123" ] } } } } ] } ] }, "notificationConfig": { "rules": [ { "eventType": "PRICE_CHANGE", "scope": "PROPERTY", "variationPercent": [ { "gte": -5, "lte": -3 } ] } ] }, "eventDestination": "https://example.com/", "signingKey": "whsec_abc123...", "signingKeyHint": "b75b1473", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2026-01-15T10:30:00+00:00", "updatedAt": "2026-05-20T14:45:00+00:00"}List alerts GET
List alerts
Alert event triggered Webhook
Sent to your webhook URL when an alert event fires. Verify the HMAC signature (see headers below) and reply with a 2xx status; anything else is retried up to 4 times with exponential back-off. The same event may arrive more than once: use eventId as your idempotency key. The signing key is returned a single time, on the response that creates the first webhook destination of your account; rotate it from your dashboard.