POST api/{enterpriseId}/Clients/batch

To batch update clients

Request Information

URI Parameters

Name	Description	Type	Additional information
enterpriseId	Enterprise Code - identifies enterprise within AdvisorView	string	Required

Body Parameters

ClientBatchRequest

Name	Description	Type	Additional information
OrgId	OrganizationId - If CRM is Salesforce, this is required field.	string	None.
Records	Collection of Client Opertaions to be performed	Collection of ClientModel	None.

Request Formats

application/json, text/json

Sample:

{
  "OrgId": "sample string 1",
  "Records": [
    {
      "OrgId": "sample string 1",
      "ClientId": 2,
      "ClientCrmId": "sample string 3",
      "HouseholdId": 1,
      "HouseholdCrmId": "sample string 4",
      "Email": "sample string 5",
      "FirstName": "sample string 6",
      "MiddleName": "sample string 7",
      "LastName": "sample string 8",
      "IndividualCrmId": "sample string 9",
      "DateOfbirth": "2025-06-07T07:35:19.3307949-07:00",
      "PortalStatus": "sample string 10",
      "UpdatedByTamaracIntegration": true
    },
    {
      "OrgId": "sample string 1",
      "ClientId": 2,
      "ClientCrmId": "sample string 3",
      "HouseholdId": 1,
      "HouseholdCrmId": "sample string 4",
      "Email": "sample string 5",
      "FirstName": "sample string 6",
      "MiddleName": "sample string 7",
      "LastName": "sample string 8",
      "IndividualCrmId": "sample string 9",
      "DateOfbirth": "2025-06-07T07:35:19.3307949-07:00",
      "PortalStatus": "sample string 10",
      "UpdatedByTamaracIntegration": true
    }
  ]
}

application/xml, text/xml

Sample:

<ClientBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tamarac.Advisor.AdvisorApi.Models">
  <OrgId>sample string 1</OrgId>
  <Records>
    <ClientModel>
      <ClientCrmId>sample string 3</ClientCrmId>
      <ClientId>2</ClientId>
      <DateOfbirth>2025-06-07T07:35:19.3307949-07:00</DateOfbirth>
      <Email>sample string 5</Email>
      <FirstName>sample string 6</FirstName>
      <HouseholdCrmId>sample string 4</HouseholdCrmId>
      <HouseholdId>1</HouseholdId>
      <IndividualCrmId>sample string 9</IndividualCrmId>
      <LastName>sample string 8</LastName>
      <MiddleName>sample string 7</MiddleName>
      <OrgId>sample string 1</OrgId>
      <PortalStatus>sample string 10</PortalStatus>
      <UpdatedByTamaracIntegration>true</UpdatedByTamaracIntegration>
    </ClientModel>
    <ClientModel>
      <ClientCrmId>sample string 3</ClientCrmId>
      <ClientId>2</ClientId>
      <DateOfbirth>2025-06-07T07:35:19.3307949-07:00</DateOfbirth>
      <Email>sample string 5</Email>
      <FirstName>sample string 6</FirstName>
      <HouseholdCrmId>sample string 4</HouseholdCrmId>
      <HouseholdId>1</HouseholdId>
      <IndividualCrmId>sample string 9</IndividualCrmId>
      <LastName>sample string 8</LastName>
      <MiddleName>sample string 7</MiddleName>
      <OrgId>sample string 1</OrgId>
      <PortalStatus>sample string 10</PortalStatus>
      <UpdatedByTamaracIntegration>true</UpdatedByTamaracIntegration>
    </ClientModel>
  </Records>
</ClientBatchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClientResponse

Name	Description	Type	Additional information
StatusCode	Standard Http status codes	HttpStatusCode	None.
StatusMessage	Status message	string	None.
Client	Client Model	ClientModel	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusCode": 100,
  "StatusMessage": "sample string 1",
  "Client": {
    "OrgId": "sample string 1",
    "ClientId": 2,
    "ClientCrmId": "sample string 3",
    "HouseholdId": 1,
    "HouseholdCrmId": "sample string 4",
    "Email": "sample string 5",
    "FirstName": "sample string 6",
    "MiddleName": "sample string 7",
    "LastName": "sample string 8",
    "IndividualCrmId": "sample string 9",
    "DateOfbirth": "2025-06-07T07:35:19.3464518-07:00",
    "PortalStatus": "sample string 10",
    "UpdatedByTamaracIntegration": true
  }
}

application/xml, text/xml

Sample:

<ClientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tamarac.Advisor.AdvisorApi.Models">
  <Client>
    <ClientCrmId>sample string 3</ClientCrmId>
    <ClientId>2</ClientId>
    <DateOfbirth>2025-06-07T07:35:19.3464518-07:00</DateOfbirth>
    <Email>sample string 5</Email>
    <FirstName>sample string 6</FirstName>
    <HouseholdCrmId>sample string 4</HouseholdCrmId>
    <HouseholdId>1</HouseholdId>
    <IndividualCrmId>sample string 9</IndividualCrmId>
    <LastName>sample string 8</LastName>
    <MiddleName>sample string 7</MiddleName>
    <OrgId>sample string 1</OrgId>
    <PortalStatus>sample string 10</PortalStatus>
    <UpdatedByTamaracIntegration>true</UpdatedByTamaracIntegration>
  </Client>
  <StatusCode>Continue</StatusCode>
  <StatusMessage>sample string 1</StatusMessage>
</ClientResponse>