POST api/prospects/search
Request Information
URI Parameters
None.
Body Parameters
ProspectSearchDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Prospect | CampaignPreviewDto |
None. |
|
| Person | PersonSearchDto |
None. |
|
| Skip | integer |
None. |
|
| Take | integer |
None. |
|
| SortOrder | string |
None. |
|
| IsNotStopped | boolean |
None. |
|
| HasNoFailedTelephone | boolean |
None. |
|
| HasNoFailedEmail | boolean |
None. |
|
| OrFilters | Collection of globally unique identifier |
None. |
|
| Products | Collection of globally unique identifier |
None. |
|
| Campaigns | Collection of globally unique identifier |
None. |
|
| NotReceivedMarketingInDays | integer |
None. |
|
| NotPutOrderInDays | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"prospect": {
"campaignId": "92929a23-447c-4fcb-a175-64dc93e08277",
"toPersonIds": [
"5b1e56bd-8678-49f6-99ee-94a8bd46d5d2",
"20d39c64-70a0-4089-9f49-a1354b657305"
],
"isNewPerson": true,
"email": "sample string 2",
"telephone": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"address": "sample string 6",
"postcode": "sample string 7",
"city": "sample string 8",
"productIds": [
"sample string 1",
"sample string 2"
],
"filterIds": [
"509d89ca-507d-47f7-ad96-c1551f6e1033",
"a017b8f8-1f88-4764-99de-497e291ff848"
],
"filterMaxCount": 9,
"filterNoOrderInDays": 10,
"filterNoCampaignInDays": 11,
"filterMustNotBeStopped": true,
"filterOrderOnProducts": [
"8947d405-5a58-458c-ae6d-ff4f8f9bf6df",
"063e7249-70ea-4049-a49e-7bae12612fb4"
],
"filterOrderOnCampaigns": [
"775e36d7-ba37-43ad-a199-046e86f6b558",
"e92dab7b-bd39-41f6-9754-bdbfaa1c7741"
],
"destinationType": "sample string 13"
},
"person": {
"name": "sample string 1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"address": "sample string 4",
"postcode": "sample string 5",
"city": "sample string 6",
"country": "sample string 7",
"shortUnique": "sample string 8",
"email": "sample string 9",
"telephone": "sample string 10",
"inCampaign": "sample string 11",
"updatedFrom": "2025-12-30T23:41:10.0463997+01:00",
"updatedTo": "2025-12-30T23:41:10.0463997+01:00",
"lastBuyFrom": "2025-12-30T23:41:10.0463997+01:00",
"lastBuyTo": "2025-12-30T23:41:10.0463997+01:00",
"inActiveCampaign": true,
"recentlyBought": true,
"sortBy": "sample string 12",
"esecoCustomerNumber": "sample string 13",
"personalNumber": "sample string 14",
"products": {
"products": [
"74fb74fb-9495-4d78-ba03-efeffc09084b",
"7968f972-973e-495e-b2f2-524d519c69d2"
],
"not": true,
"from": "2025-12-30T23:41:10.0463997+01:00",
"to": "2025-12-30T23:41:10.0463997+01:00"
},
"campaigns": {
"campaigns": [
"4aff2cfb-b63d-43bb-a420-29b97c7f4f40",
"1b19ecbc-1e9f-4b36-ad93-16e8406ddf54"
],
"not": true,
"from": "2025-12-30T23:41:10.0463997+01:00",
"to": "2025-12-30T23:41:10.0463997+01:00"
},
"isStop": true,
"isDiseased": true,
"isFailedEmail": true,
"isFailedSms": true,
"searchOnlyPersons": true,
"tag": "sample string 15"
},
"skip": 1,
"take": 2,
"sortOrder": "sample string 3",
"isNotStopped": true,
"hasNoFailedTelephone": true,
"hasNoFailedEmail": true,
"orFilters": [
"731aa31a-f67c-43e7-8899-ba62ec6c6e9b",
"36e0d8aa-4d8f-4897-8d63-55c54ae964ee"
],
"products": [
"4ed26c8d-ba38-4cf8-b5f9-a363eaf0d5c1",
"eb003d1d-7512-4037-9724-fbb4a4ae79d4"
],
"campaigns": [
"c1f93ff6-af0a-40f7-bfbf-0dbfdef4eb32",
"f540f405-8216-45fc-a03d-822a15b2db10"
],
"notReceivedMarketingInDays": 7,
"notPutOrderInDays": 8
}
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.