PUT api/Clients/BatchShare

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
sharingModel 
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "Shares": [
    {
      "Email": "sample string 1",
      "UserId": "8cbd6ef9-3ef1-4d62-8bea-eca0cbeafea1",
      "Permission": 0
    },
    {
      "Email": "sample string 1",
      "UserId": "8cbd6ef9-3ef1-4d62-8bea-eca0cbeafea1",
      "Permission": 0
    },
    {
      "Email": "sample string 1",
      "UserId": "8cbd6ef9-3ef1-4d62-8bea-eca0cbeafea1",
      "Permission": 0
    }
  ],
  "Privacy": 0,
  "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": "1739e2d0-ac81-43fb-bf19-fae0216a11e8",
    "accountingId": "sample string 7",
    "notWithCampaignId": 1,
    "excludePersonIds": [
      "a37a8e66-15f1-4cd9-95b5-29a6c16839f8",
      "b6ad1e3a-462a-4bab-a52c-ef5d65310a03",
      "5a30e2ff-851e-40f3-a017-56e4f3692107"
    ],
    "excludeBusinessIds": [
      "bd8a8daa-8b20-4dea-bdbc-30d73806defb",
      "c26b2ed9-8384-411c-9f0e-dffe28cfba4a",
      "cdc61d17-7eb9-46dd-bb7b-0da0e3f1100d"
    ],
    "clientIds": [
      "baedea4a-a400-4e5b-811a-aee17076da44",
      "b23bf0dd-4759-4642-9a5b-42873df141e5",
      "2b493c70-a738-4395-aef1-28211e253d42"
    ],
    "expectedBroadcastDate": "2025-12-30T18:49:29.7627037+02:00",
    "fromExpectedBroadcastDate": "2025-12-30T18:49:29.7627037+02:00",
    "fromBroadcastDate": "2025-12-30T18:49:29.7627037+02:00",
    "toBroadcastDate": "2025-12-30T18:49:29.7627037+02:00",
    "fromOrkaDate": "2025-12-30T18:49:29.7627037+02:00",
    "toOrkaDate": "2025-12-30T18:49:29.7627037+02:00",
    "isBroadcasted": true,
    "agentIds": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    "taxYear": 1,
    "sharingPermission": 0
  }
}

text/xml

Sample: 
<ClientBatchSharingModel 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>baedea4a-a400-4e5b-811a-aee17076da44</d3p1:guid>
      <d3p1:guid>b23bf0dd-4759-4642-9a5b-42873df141e5</d3p1:guid>
      <d3p1:guid>2b493c70-a738-4395-aef1-28211e253d42</d3p1:guid>
    </d2p1:ClientIds>
    <d2p1:ExcludeBusinessIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>bd8a8daa-8b20-4dea-bdbc-30d73806defb</d3p1:guid>
      <d3p1:guid>c26b2ed9-8384-411c-9f0e-dffe28cfba4a</d3p1:guid>
      <d3p1:guid>cdc61d17-7eb9-46dd-bb7b-0da0e3f1100d</d3p1:guid>
    </d2p1:ExcludeBusinessIds>
    <d2p1:ExcludePersonIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>a37a8e66-15f1-4cd9-95b5-29a6c16839f8</d3p1:guid>
      <d3p1:guid>b6ad1e3a-462a-4bab-a52c-ef5d65310a03</d3p1:guid>
      <d3p1:guid>5a30e2ff-851e-40f3-a017-56e4f3692107</d3p1:guid>
    </d2p1:ExcludePersonIds>
    <d2p1:ExpectedBroadcastDate>2025-12-30T18:49:29.7627037+02:00</d2p1:ExpectedBroadcastDate>
    <d2p1:ExternalId>1</d2p1:ExternalId>
    <d2p1:FromBroadcastDate>2025-12-30T18:49:29.7627037+02:00</d2p1:FromBroadcastDate>
    <d2p1:FromExpectedBroadcastDate>2025-12-30T18:49:29.7627037+02:00</d2p1:FromExpectedBroadcastDate>
    <d2p1:FromOrkaDate>2025-12-30T18:49:29.7627037+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>1739e2d0-ac81-43fb-bf19-fae0216a11e8</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:29.7627037+02:00</d2p1:ToBroadcastDate>
    <d2p1:ToOrkaDate>2025-12-30T18:49:29.7627037+02:00</d2p1:ToOrkaDate>
  </Filters>
  <IsSelectedAll>true</IsSelectedAll>
  <Privacy>PublicRead</Privacy>
  <Shares xmlns:d2p1="http://schemas.datacontract.org/2004/07/Heshev.Common.DomainLogic.Sharing">
    <d2p1:SharingUserModel>
      <d2p1:Email>sample string 1</d2p1:Email>
      <d2p1:Permission>Read</d2p1:Permission>
      <d2p1:UserId>8cbd6ef9-3ef1-4d62-8bea-eca0cbeafea1</d2p1:UserId>
    </d2p1:SharingUserModel>
    <d2p1:SharingUserModel>
      <d2p1:Email>sample string 1</d2p1:Email>
      <d2p1:Permission>Read</d2p1:Permission>
      <d2p1:UserId>8cbd6ef9-3ef1-4d62-8bea-eca0cbeafea1</d2p1:UserId>
    </d2p1:SharingUserModel>
    <d2p1:SharingUserModel>
      <d2p1:Email>sample string 1</d2p1:Email>
      <d2p1:Permission>Read</d2p1:Permission>
      <d2p1:UserId>8cbd6ef9-3ef1-4d62-8bea-eca0cbeafea1</d2p1:UserId>
    </d2p1:SharingUserModel>
  </Shares>
</ClientBatchSharingModel>

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.