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": "13052ef8-7755-435f-907d-be9e8b659e95",
"toPersonIds": [
"26e2a402-cd9e-4192-952f-44ee79d089f8",
"d9ab3c94-9713-48d9-b345-16d64b3bc1d4"
],
"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": [
"9d0c8ccc-4670-4928-a207-24885f94a5e7",
"443f4601-2527-4306-9da2-12cfc21de98c"
],
"filterMaxCount": 9,
"filterNoOrderInDays": 10,
"filterNoCampaignInDays": 11,
"filterMustNotBeStopped": true,
"filterOrderOnProducts": [
"651bae6a-4066-4620-a451-b488006cacb6",
"c8d6501e-ca80-4add-ad11-ecdd5b1056f7"
],
"filterOrderOnCampaigns": [
"748c1c93-eed2-47b7-9bd1-ebb5d57caf18",
"1ba8aff8-4464-4947-ac98-8dcbe3769770"
],
"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": "2026-07-10T03:11:09.0866058+02:00",
"updatedTo": "2026-07-10T03:11:09.0866058+02:00",
"lastBuyFrom": "2026-07-10T03:11:09.0866058+02:00",
"lastBuyTo": "2026-07-10T03:11:09.0866058+02:00",
"inActiveCampaign": true,
"recentlyBought": true,
"sortBy": "sample string 12",
"esecoCustomerNumber": "sample string 13",
"personalNumber": "sample string 14",
"products": {
"products": [
"f893370b-098f-42f3-b315-ac780f9413d8",
"4564344e-864d-4b7f-85cc-64f88f7a9f33"
],
"not": true,
"from": "2026-07-10T03:11:09.0866058+02:00",
"to": "2026-07-10T03:11:09.0866058+02:00"
},
"campaigns": {
"campaigns": [
"672884b4-f02e-4afc-a019-236ea2b3846c",
"bdeabb44-b214-43f0-a5df-f0372b0ed416"
],
"not": true,
"from": "2026-07-10T03:11:09.0866058+02:00",
"to": "2026-07-10T03:11:09.0866058+02: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": [
"51549927-8886-450c-9935-28e78b2f2190",
"96dcae39-9b4f-4555-b6b3-9f264045a57c"
],
"products": [
"fb63d827-4725-432f-8feb-9b6cd617a506",
"c4726c83-9e8a-48d8-bd29-eaf2ff0c1121"
],
"campaigns": [
"5247d18a-7afc-4254-aebb-0f429f8a3026",
"982d0801-28ca-428e-a513-9aab4538c2ce"
],
"notReceivedMarketingInDays": 7,
"notPutOrderInDays": 8
}
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.