Save a hunt alert
save_hunt_alertSaves a hunt alert for this query after the seeker agrees to share their email with partners whose listings match, and emails them when a home matches. Requires consent true. Does not accept a phone number. A phone is shared later only on the website, and only with the partner whose property the seeker shortlists. Creates a seeker account when the email is new. An email that already has an account is not attached from this tool; the hunt stays pending until that person confirms it. Verify your phone so matching partners can reach you.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | Yes | City slug | |
| name | No | Seeker display name | |
| Yes | Email the seeker agreed to share | ||
| has_ac | No | True only when AC is required. Omit or false means not required, not excluded. | |
| status | No | Household: Single, Couple, or Family (values single, partner, or family). single matches Everyone and Singles only. partner is Couple and matches Everyone and Couples. family matches Everyone and Families only. | |
| consent | Yes | True only when the seeker has explicitly agreed, for this query, to share this email with partners whose listings match. This is not consent to share a phone number. | |
| area_min | No | Optional minimum apartment size. Pair with area_unit. Omit for any size. | |
| currency | No | Budget currency for price_max. Defaults to the city's local currency. USD rates are the live cached interbank quote. Saved alerts store the USD equivalent. | |
| has_lift | No | True only when a lift or elevator is required. Omit or false means not required, not excluded. | |
| has_pets | No | True when the seeker has pets. Excludes homes that explicitly disallow pets. Unknown pet policy still appears as ask about pets. | |
| locality | No | Exact area inside the city, such as Baner or Kharadi. A Baner search does not return Hinjewadi. | |
| area_unit | No | Unit for area_min. Use sqft in Pune and sqm in other cities. Defaults from the city when area_min is set and this is omitted. | |
| furnished | No | Set true only when the seeker explicitly asks for furnished. Omit for any furnishing. | |
| hunt_name | No | Optional label for the saved hunt | |
| no_curfew | No | True when the seeker needs no gate curfew. Omit or false means not required, not excluded. | |
| price_max | No | Max monthly rent in `currency` units. Defaults to the city's local currency (Pune INR, Dubai/Sharjah AED, Bangkok/Phuket THB, Vietnam VND). Example: 30000 INR, 4000 AED. | |
| lock_in_max | No | Max lock-in months the seeker will accept | |
| stay_nights | No | Desired stay length in nights (7=1 week … 330=11 months, 365=12 months). 11 months is offered everywhere; it is the standard residential lease in India. | |
| available_by | No | Move-in by date, YYYY-MM-DD | |
| bedrooms_min | No | ||
| near_transit | No | True only when near transit is required. Omit or false means not required, not excluded. | |
| pet_friendly | No | True only when pets are required. Omit or false means not required, not excluded. | |
| attached_bath | No | True only when an attached bath is required. Omit or false means not required, not excluded. | |
| near_coworking | No | True only when near coworking is required. Omit or false means not required, not excluded. | |
| deposit_months_max | No | Max security deposit in months of rent |