POST api/leadpulse/preview

Preview a lead pulse filter, use this before creating the item in the database to see exactly what you might get.

Request Information

URI Parameters

None.

Body Parameters

Filter data

Name	Type	Additional information
Name	string	None.
Description	string	None.
Type	string	None.
Districts	string	None.
Sectors	string	None.
Postcodes	string	None.
Beds	string	None.
Search	string	None.
PropertyType	string	None.
Price_From	integer	None.
Price_To	integer	None.
Date_Listed_From	date	None.
Date_Listed_To	date	None.
Agents	string	None.
North	decimal number	None.
South	decimal number	None.
East	decimal number	None.
West	decimal number	None.
Sort	string	None.
Limit	integer	None.
AutoProcess	boolean	None.
MaxPerProperty	integer	None.
StatusOrder	string	None.
Active	boolean	None.
CreatedDate	date	None.
UpdatedDate	date	None.
CreatedById	integer	None.
CreatedBy	string	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Type": "sample string 3",
  "Districts": "sample string 4",
  "Sectors": "sample string 5",
  "Postcodes": "sample string 6",
  "Beds": "sample string 7",
  "Search": "sample string 8",
  "PropertyType": "sample string 9",
  "Price_From": 1,
  "Price_To": 1,
  "Date_Listed_From": "2025-11-18T14:09:21.9302088Z",
  "Date_Listed_To": "2025-11-18T14:09:21.9302088Z",
  "Agents": "sample string 10",
  "North": 11.1,
  "South": 12.1,
  "East": 13.1,
  "West": 14.1,
  "Sort": "sample string 15",
  "Limit": 16,
  "AutoProcess": true,
  "MaxPerProperty": 18,
  "StatusOrder": "sample string 19",
  "Active": true,
  "CreatedDate": "2025-11-18T14:09:21.9302088Z",
  "UpdatedDate": "2025-11-18T14:09:21.9302088Z",
  "CreatedById": 21,
  "CreatedBy": "sample string 22",
  "Id": 23
}

Response Information

Resource Description

200 OK with preview data, 400 Bad Request, or 404 Not Found

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.