PUT api/{enterpriseId}/Clients/{id}
To update a client
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
enterpriseId |
Enterprise Code - identifies enterprise within AdvisorView |
string |
Required |
id |
AdvisorView Id of the client |
integer |
Required |
Body Parameters
ClientModelName | Description | Type | Additional information |
---|---|---|---|
OrgId |
OrganizationId - If CRM is Salesforce, this is required field. |
string |
None. |
ClientId |
Id to identify client within AdvisorView system |
integer |
None. |
ClientCrmId |
Id to identify client within CRM system |
string |
None. |
HouseholdId |
Id to identify household within AdvisorView system |
integer |
None. |
HouseholdCrmId |
To identify household CrmId |
string |
None. |
Email address associated with client. Must be unique for each client |
string |
None. |
|
FirstName |
First name for the client |
string |
None. |
MiddleName |
Middle name for the client |
string |
None. |
LastName |
Last name for the client |
string |
None. |
IndividualCrmId |
The individual account crm id for the client |
string |
None. |
DateOfbirth |
DateOfBirth for the client |
date |
None. |
PortalStatus | string |
None. |
|
UpdatedByTamaracIntegration | boolean |
None. |
Request Formats
application/json, text/json
{ "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-07T08:08:19.0134351-07:00", "PortalStatus": "sample string 10", "UpdatedByTamaracIntegration": true }
application/xml, text/xml
<ClientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tamarac.Advisor.AdvisorApi.Models"> <ClientCrmId>sample string 3</ClientCrmId> <ClientId>2</ClientId> <DateOfbirth>2025-06-07T08:08:19.0134351-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>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ClientModelName | Description | Type | Additional information |
---|---|---|---|
OrgId |
OrganizationId - If CRM is Salesforce, this is required field. |
string |
None. |
ClientId |
Id to identify client within AdvisorView system |
integer |
None. |
ClientCrmId |
Id to identify client within CRM system |
string |
None. |
HouseholdId |
Id to identify household within AdvisorView system |
integer |
None. |
HouseholdCrmId |
To identify household CrmId |
string |
None. |
Email address associated with client. Must be unique for each client |
string |
None. |
|
FirstName |
First name for the client |
string |
None. |
MiddleName |
Middle name for the client |
string |
None. |
LastName |
Last name for the client |
string |
None. |
IndividualCrmId |
The individual account crm id for the client |
string |
None. |
DateOfbirth |
DateOfBirth for the client |
date |
None. |
PortalStatus | string |
None. |
|
UpdatedByTamaracIntegration | boolean |
None. |
Response Formats
application/json, text/json
{ "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-07T08:08:19.0134351-07:00", "PortalStatus": "sample string 10", "UpdatedByTamaracIntegration": true }
application/xml, text/xml
<ClientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tamarac.Advisor.AdvisorApi.Models"> <ClientCrmId>sample string 3</ClientCrmId> <ClientId>2</ClientId> <DateOfbirth>2025-06-07T08:08:19.0134351-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>