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. Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

Filter data

LeadPulseFilterDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Description	The description value.	string	None.
Type	The type value.	string	None.
Districts	The districts value.	string	None.
Sectors	The sectors value.	string	None.
Postcodes	The postcodes value.	string	None.
Beds	The beds value.	string	None.
Search	The search value.	string	None.
PropertyType	The property type value.	string	None.
Price_From	The price from value.	integer	None.
Price_To	The price to value.	integer	None.
Date_Listed_From	The date listed from, expressed as a date and time.	date	None.
Date_Listed_To	The date listed to, expressed as a date and time.	date	None.
Agents	The agents value.	string	None.
North	The north value.	decimal number	None.
South	The south value.	decimal number	None.
East	The east value.	decimal number	None.
West	The west value.	decimal number	None.
Sort	The sort value.	string	None.
Limit	The limit value.	integer	None.
AutoProcess	Indicates whether auto process is true.	boolean	None.
MaxPerProperty	The max per property value.	integer	None.
StatusOrder	The status order value.	string	None.
Active	Indicates whether active is true.	boolean	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
UpdatedDate	The updated date, expressed as a date and time.	date	None.
CreatedById	The unique identifier of the related created by resource.	integer	None.
CreatedBy	The created by value.	string	None.
Id	The unique identifier of this resource.	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": "2026-07-23T10:33:51.3398251Z",
  "Date_Listed_To": "2026-07-23T10:33:51.3398251Z",
  "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": "2026-07-23T10:33:51.3398251Z",
  "UpdatedDate": "2026-07-23T10:33:51.3403593Z",
  "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.