PUT api/Clients/BatchArchive
No documentation available.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| model | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"isSelectedAll": true,
"filters": {
"businessTypes": [
0,
0,
0
],
"terms": "sample string 1",
"isPeopleSearch": true,
"standAloneOnly": true,
"owner": "sample string 4",
"isMine": true,
"taxpayersOnly": true,
"idNumber": "sample string 5",
"isExactIdNumber": true,
"idNumbers": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"isNotArchived": true,
"externalId": 1,
"hasExternalId": true,
"myOrganizationOnly": true,
"hasPaperlessId": true,
"hasEmail": true,
"hasCellphone": true,
"paperlessId": "73a06b84-fdf4-43e0-bf4b-46c633b1b049",
"accountingId": "sample string 7",
"notWithCampaignId": 1,
"excludePersonIds": [
"1dc8bc60-aea3-4092-8356-45b9cea3c8cc",
"6c82ddbd-321e-49cc-bb67-ac100e3136b9",
"e4b7a996-6992-4cd9-be51-33a96e9322ea"
],
"excludeBusinessIds": [
"ea4a7e93-2a92-4b02-b260-1f1fd81c0e57",
"cc57ce5e-b4d7-4e6d-8d85-7e9ea4437eb0",
"ffb4a0e6-375c-447c-953a-5886b435118a"
],
"clientIds": [
"6cdf7304-7742-499b-b54f-1be47dcb6bc5",
"b06b27ce-10ad-44ff-b77b-b1e819cb98f3",
"9e0505ca-e8c0-4d67-b0c9-96ce669f026e"
],
"expectedBroadcastDate": "2026-02-28T10:26:32.8267076+02:00",
"fromExpectedBroadcastDate": "2026-02-28T10:26:32.8267076+02:00",
"fromBroadcastDate": "2026-02-28T10:26:32.8267076+02:00",
"toBroadcastDate": "2026-02-28T10:26:32.8267076+02:00",
"fromOrkaDate": "2026-02-28T10:26:32.8267076+02:00",
"toOrkaDate": "2026-02-28T10:26:32.8267076+02:00",
"isBroadcasted": true,
"agentIds": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"taxYear": 1,
"sharingPermission": 0
}
}
text/xml
Sample:
<ClientBatchUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Heshev.Site.Api.Models">
<Filters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Heshev.Crm.DomainLogic.Common">
<d2p1:AccountingId>sample string 7</d2p1:AccountingId>
<d2p1:AgentIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
<d3p1:string>sample string 3</d3p1:string>
</d2p1:AgentIds>
<d2p1:BusinessTypes>
<d2p1:BusinessType>Unknown</d2p1:BusinessType>
<d2p1:BusinessType>Unknown</d2p1:BusinessType>
<d2p1:BusinessType>Unknown</d2p1:BusinessType>
</d2p1:BusinessTypes>
<d2p1:ClientIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>6cdf7304-7742-499b-b54f-1be47dcb6bc5</d3p1:guid>
<d3p1:guid>b06b27ce-10ad-44ff-b77b-b1e819cb98f3</d3p1:guid>
<d3p1:guid>9e0505ca-e8c0-4d67-b0c9-96ce669f026e</d3p1:guid>
</d2p1:ClientIds>
<d2p1:ExcludeBusinessIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>ea4a7e93-2a92-4b02-b260-1f1fd81c0e57</d3p1:guid>
<d3p1:guid>cc57ce5e-b4d7-4e6d-8d85-7e9ea4437eb0</d3p1:guid>
<d3p1:guid>ffb4a0e6-375c-447c-953a-5886b435118a</d3p1:guid>
</d2p1:ExcludeBusinessIds>
<d2p1:ExcludePersonIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>1dc8bc60-aea3-4092-8356-45b9cea3c8cc</d3p1:guid>
<d3p1:guid>6c82ddbd-321e-49cc-bb67-ac100e3136b9</d3p1:guid>
<d3p1:guid>e4b7a996-6992-4cd9-be51-33a96e9322ea</d3p1:guid>
</d2p1:ExcludePersonIds>
<d2p1:ExpectedBroadcastDate>2026-02-28T10:26:32.8267076+02:00</d2p1:ExpectedBroadcastDate>
<d2p1:ExternalId>1</d2p1:ExternalId>
<d2p1:FromBroadcastDate>2026-02-28T10:26:32.8267076+02:00</d2p1:FromBroadcastDate>
<d2p1:FromExpectedBroadcastDate>2026-02-28T10:26:32.8267076+02:00</d2p1:FromExpectedBroadcastDate>
<d2p1:FromOrkaDate>2026-02-28T10:26:32.8267076+02:00</d2p1:FromOrkaDate>
<d2p1:HasCellphone>true</d2p1:HasCellphone>
<d2p1:HasEmail>true</d2p1:HasEmail>
<d2p1:HasExternalId>true</d2p1:HasExternalId>
<d2p1:HasPaperlessId>true</d2p1:HasPaperlessId>
<d2p1:IdNumber>sample string 5</d2p1:IdNumber>
<d2p1:IdNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
<d3p1:string>sample string 3</d3p1:string>
</d2p1:IdNumbers>
<d2p1:IsBroadcasted>true</d2p1:IsBroadcasted>
<d2p1:IsExactIdNumber>true</d2p1:IsExactIdNumber>
<d2p1:IsMine>true</d2p1:IsMine>
<d2p1:IsNotArchived>true</d2p1:IsNotArchived>
<d2p1:IsPeopleSearch>true</d2p1:IsPeopleSearch>
<d2p1:MyOrganizationOnly>true</d2p1:MyOrganizationOnly>
<d2p1:NotWithCampaignId>1</d2p1:NotWithCampaignId>
<d2p1:Owner>sample string 4</d2p1:Owner>
<d2p1:PaperlessId>73a06b84-fdf4-43e0-bf4b-46c633b1b049</d2p1:PaperlessId>
<d2p1:SharingPermission>Read</d2p1:SharingPermission>
<d2p1:StandAloneOnly>true</d2p1:StandAloneOnly>
<d2p1:TaxYear>1</d2p1:TaxYear>
<d2p1:TaxpayersOnly>true</d2p1:TaxpayersOnly>
<d2p1:Terms>sample string 1</d2p1:Terms>
<d2p1:ToBroadcastDate>2026-02-28T10:26:32.8267076+02:00</d2p1:ToBroadcastDate>
<d2p1:ToOrkaDate>2026-02-28T10:26:32.8267076+02:00</d2p1:ToOrkaDate>
</Filters>
<IsSelectedAll>true</IsSelectedAll>
</ClientBatchUpdateModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
No documentation available.
Response body formats
application/json, text/json, text/xml
Sample:
Sample not available.