PUT api/prospects/get/{start}/{length}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| start | string |
Required |
|
| length | string |
Required |
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": "3a0fe5fe-0a9f-434d-aeb6-1fd252b5071e",
"toPersonIds": [
"24006869-6118-4737-8a0e-0f119f2d573c",
"41b5e8ab-0658-489a-99b2-c65a65ff44af"
],
"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": [
"33333ba4-9b96-44d3-bd10-40542c707b0b",
"f4b33fc9-8b56-47d9-8921-0193bc1e818d"
],
"filterMaxCount": 9,
"filterNoOrderInDays": 10,
"filterNoCampaignInDays": 11,
"filterMustNotBeStopped": true,
"filterOrderOnProducts": [
"b845ed12-5daf-407f-b1dc-3e33cf9de356",
"9c343b8d-0533-4a45-9c60-a6ea43e22f94"
],
"filterOrderOnCampaigns": [
"91ea43de-afc3-407d-9b06-c65ca014c821",
"6f6bea95-9cd1-44cc-a8ce-c2e544b6fd10"
],
"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:42:05.1308288+01:00",
"updatedTo": "2025-12-30T23:42:05.1308288+01:00",
"lastBuyFrom": "2025-12-30T23:42:05.1308288+01:00",
"lastBuyTo": "2025-12-30T23:42:05.1308288+01:00",
"inActiveCampaign": true,
"recentlyBought": true,
"sortBy": "sample string 12",
"esecoCustomerNumber": "sample string 13",
"personalNumber": "sample string 14",
"products": {
"products": [
"75f22a48-ed7e-4476-9a64-ae0200e54641",
"75e63498-6a0a-4c27-80a0-c9aec6203a8e"
],
"not": true,
"from": "2025-12-30T23:42:05.1308288+01:00",
"to": "2025-12-30T23:42:05.1308288+01:00"
},
"campaigns": {
"campaigns": [
"ce92d9c7-b7ba-4f3c-add8-8858dc402cbc",
"f2e967ad-363c-4ef3-9fe8-b31cee8cfa5a"
],
"not": true,
"from": "2025-12-30T23:42:05.1308288+01:00",
"to": "2025-12-30T23:42:05.1308288+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": [
"d6d84159-daec-473d-96cf-a8e3cf46c7ca",
"ad298f53-8343-4ae2-9c99-215446be9a54"
],
"products": [
"678cf036-062a-4b25-bdc0-cd1221a07265",
"b538b538-02b0-422d-bb1c-e7af3a006e0e"
],
"campaigns": [
"fecc186c-4575-48ab-9e3f-43bf6ce86a8e",
"16ef22ed-aabd-413c-a2b8-95f3a8a865e7"
],
"notReceivedMarketingInDays": 7,
"notPutOrderInDays": 8
}
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.