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": "418b8f65-4450-4e75-991a-de9284003cd1",
"accountingId": "sample string 7",
"notWithCampaignId": 1,
"excludePersonIds": [
"6950ad57-7ef7-4c41-8f8c-b533898280cd",
"20c92ffa-0e31-4e3e-b7a3-060ad30623ed",
"bb7b7c0c-ba3e-426e-991f-2e22e09fd72f"
],
"excludeBusinessIds": [
"a610b8af-2b26-4d79-8bfe-6721e1e6c4b8",
"3a106734-567c-460f-983f-427453d83aa8",
"fb64b6c1-ae97-4398-94af-6b9c27f477eb"
],
"clientIds": [
"68715000-f34f-4e43-9d7c-c406292d5ec5",
"e92a60c3-cfd2-4cb0-a103-618ee223c17a",
"ef2d1d05-98b7-44a0-b6de-4673d2f5e784"
],
"expectedBroadcastDate": "2025-12-30T18:49:18.5438882+02:00",
"fromExpectedBroadcastDate": "2025-12-30T18:49:18.5438882+02:00",
"fromBroadcastDate": "2025-12-30T18:49:18.5438882+02:00",
"toBroadcastDate": "2025-12-30T18:49:18.5438882+02:00",
"fromOrkaDate": "2025-12-30T18:49:18.5438882+02:00",
"toOrkaDate": "2025-12-30T18:49:18.5438882+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>68715000-f34f-4e43-9d7c-c406292d5ec5</d3p1:guid>
<d3p1:guid>e92a60c3-cfd2-4cb0-a103-618ee223c17a</d3p1:guid>
<d3p1:guid>ef2d1d05-98b7-44a0-b6de-4673d2f5e784</d3p1:guid>
</d2p1:ClientIds>
<d2p1:ExcludeBusinessIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>a610b8af-2b26-4d79-8bfe-6721e1e6c4b8</d3p1:guid>
<d3p1:guid>3a106734-567c-460f-983f-427453d83aa8</d3p1:guid>
<d3p1:guid>fb64b6c1-ae97-4398-94af-6b9c27f477eb</d3p1:guid>
</d2p1:ExcludeBusinessIds>
<d2p1:ExcludePersonIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>6950ad57-7ef7-4c41-8f8c-b533898280cd</d3p1:guid>
<d3p1:guid>20c92ffa-0e31-4e3e-b7a3-060ad30623ed</d3p1:guid>
<d3p1:guid>bb7b7c0c-ba3e-426e-991f-2e22e09fd72f</d3p1:guid>
</d2p1:ExcludePersonIds>
<d2p1:ExpectedBroadcastDate>2025-12-30T18:49:18.5438882+02:00</d2p1:ExpectedBroadcastDate>
<d2p1:ExternalId>1</d2p1:ExternalId>
<d2p1:FromBroadcastDate>2025-12-30T18:49:18.5438882+02:00</d2p1:FromBroadcastDate>
<d2p1:FromExpectedBroadcastDate>2025-12-30T18:49:18.5438882+02:00</d2p1:FromExpectedBroadcastDate>
<d2p1:FromOrkaDate>2025-12-30T18:49:18.5438882+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>418b8f65-4450-4e75-991a-de9284003cd1</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>2025-12-30T18:49:18.5438882+02:00</d2p1:ToBroadcastDate>
<d2p1:ToOrkaDate>2025-12-30T18:49:18.5438882+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.