POST api/business-users/me/clients

This method will add a new client for a business user

Requires Authorization!

Request Information

URI Parameters

None.

Body Parameters

New client data. Instance of

Name	Type	Additional information
FirstName	string	None.
LastName	string	None.
CompanyName	string	None.
Email	string	None.
Phone	string	None.
Cell	string	None.
ReturnYear	integer	None.
DisabilityLevel	decimal number	None.
DisabilityYear	integer	None.
Birthday	date	None.
IsProspect	boolean	None.
AnnualIncome	decimal number	None.
Notes	string	None.
IsBuilder	boolean	None.
NotificationsEnabled	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "firstName": "sample string 1",
  "lastName": "sample string 2",
  "companyName": "sample string 3",
  "email": "sample string 4",
  "phone": "sample string 5",
  "cell": "sample string 6",
  "returnYear": 1,
  "disabilityLevel": 1.0,
  "disabilityYear": 1,
  "birthday": "2025-05-20T15:55:09.3751152-05:00",
  "isProspect": true,
  "annualIncome": 1.0,
  "notes": "sample string 8",
  "isBuilder": true,
  "notificationsEnabled": true
}

text/html

Sample:

{"firstName":"sample string 1","lastName":"sample string 2","companyName":"sample string 3","email":"sample string 4","phone":"sample string 5","cell":"sample string 6","returnYear":1,"disabilityLevel":1.0,"disabilityYear":1,"birthday":"2025-05-20T15:55:09.3751152-05:00","isProspect":true,"annualIncome":1.0,"notes":"sample string 8","isBuilder":true,"notificationsEnabled":true}

application/xml, text/xml

Sample:

<BusinessUserClientBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.UserModels">
  <AnnualIncome>1</AnnualIncome>
  <Birthday>2025-05-20T15:55:09.3751152-05:00</Birthday>
  <Cell>sample string 6</Cell>
  <CompanyName>sample string 3</CompanyName>
  <DisabilityLevel>1</DisabilityLevel>
  <DisabilityYear>1</DisabilityYear>
  <Email>sample string 4</Email>
  <FirstName>sample string 1</FirstName>
  <IsBuilder>true</IsBuilder>
  <IsProspect>true</IsProspect>
  <LastName>sample string 2</LastName>
  <Notes>sample string 8</Notes>
  <NotificationsEnabled>true</NotificationsEnabled>
  <Phone>sample string 5</Phone>
  <ReturnYear>1</ReturnYear>
</BusinessUserClientBindingModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BusinessUserClientBindingModel'.

Response Information

Resource Description

Instance of

BusinessUserClient

Name	Type	Additional information
Id	integer	None.
FirstName	string	None.
LastName	string	None.
CompanyName	string	None.
Phone	string	None.
Email	string	None.
CellPhone	string	None.
IsProspect	boolean	None.
AddedDate	date	None.
AffiliateCode	string	None.
DiscountPercent	decimal number	None.
IsBuilder	boolean	None.
Notes	string	None.
NotificationsEnabled	boolean	None.
UserPersonalInfoId	integer	None.
UserBusinessInfoId	integer	None.
UserPersonalInfo	UserPersonalInfo	None.
UserBusinessInfo	UserBusinessInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "companyName": "sample string 4",
  "phone": "sample string 5",
  "email": "sample string 6",
  "cellPhone": "sample string 7",
  "isProspect": true,
  "addedDate": "2025-05-20T15:55:09.3751152-05:00",
  "affiliateCode": "sample string 10",
  "discountPercent": 11.0,
  "isBuilder": true,
  "notes": "sample string 13",
  "notificationsEnabled": true,
  "userPersonalInfoId": 15,
  "userBusinessInfoId": 16,
  "userPersonalInfo": {
    "id": 1,
    "birthday": "2025-05-20T15:55:09.3771609-05:00",
    "annualIncome": 1.0,
    "isDisabled": true,
    "isVeteran": true,
    "returnYear": 1,
    "disabilityLevel": 1.0,
    "disabilityYear": 1,
    "addedDate": "2025-05-20T15:55:09.3771609-05:00",
    "lastModifiedDate": "2025-05-20T15:55:09.3771609-05:00",
    "isOnActiveDuty": true
  },
  "userBusinessInfo": {
    "id": 1,
    "companyName": "sample string 2",
    "addressLine1": "sample string 3",
    "city": "sample string 4",
    "state": "sample string 5",
    "zip": "sample string 6",
    "countyId": 7,
    "phone": "sample string 8",
    "fax": "sample string 9",
    "email": "sample string 10",
    "cellPhone": "sample string 11",
    "bio": "sample string 12",
    "logo": "sample string 13",
    "affiliateCode": "sample string 14",
    "practiceStartYear": 1,
    "onsiteAdEnabled": true,
    "docGenEnabled": true,
    "whiteLabelEnabled": true,
    "isPreferred": true,
    "starRating": 19,
    "addedDate": "2025-05-20T15:55:09.3771609-05:00",
    "lastModifiedDate": "2025-05-20T15:55:09.3771609-05:00",
    "practiceArea": "sample string 21",
    "discountPercent": 22.0,
    "referrerAffiliateCode": "sample string 23",
    "maxPropertyCount": 1,
    "appealFeeOverride": 1.0,
    "isTestUser": true,
    "individualGiftDiscount": 25.0,
    "websiteUrl": "sample string 26",
    "contingencyFee": 1.0,
    "attorneyCode": "sample string 27",
    "isBannerVisible": true,
    "clientColor": "sample string 29",
    "clientLogo": "sample string 30",
    "appealFeeAmount": 31.0,
    "analysisFeeAmount": 32.0,
    "referralFeeAmount": 33.0,
    "forwardSiteReferrals": true,
    "referrealFeeToPtfAmount": 35.0,
    "userReportIdentifier": "sample string 36",
    "displayAppealDiscountBox": true,
    "displayHowToStartInstructions": true,
    "requireUserRegistration": true,
    "collectAnalysisFee": true,
    "iFrameBannerImageUrl": "sample string 41",
    "customContactSectionTitle": "sample string 42",
    "customContactSectionContent": "sample string 43",
    "iFrameEmailReportToWebUser": true,
    "iFrameEnabledAppeal": true,
    "iFrameEnabledAppealGuarantee": true,
    "displayQrCode": true,
    "qrCodeUrl": "sample string 48",
    "qrCodeClientUrl": "sample string 49",
    "displayEngagementPageOnReport": true,
    "engagementPageContent": "sample string 51",
    "digitalSignaturePackageUrl": "sample string 52",
    "isPtfAttorney": true,
    "isBusinessReferralAttorney": true,
    "appealProcessingEnabled": true,
    "residentialAppealExemptionFilingFee": 1.0,
    "vacancyConstructionIncomeAppealFilingFee": 1.0,
    "certificateOfErrorFilingFee": 1.0,
    "condoAssociationAppealFilingFee": 1.0,
    "isFilingFeePerAppeal": true,
    "feeSharingPercent": 1.0,
    "notes": "sample string 57",
    "isProcessingIncluded": true,
    "isPerAdditionalAppealPricing": true,
    "userId": 60,
    "user": {
      "id": 1,
      "accessFailedCount": 2,
      "email": "sample string 3",
      "emailConfirmed": true,
      "lockoutEnabled": true,
      "lockoutEndDateUtc": "2025-05-20T15:55:09.3771609-05:00",
      "passwordHash": "sample string 6",
      "phoneNumberConfirmed": true,
      "securityStamp": "sample string 8",
      "twoFactorEnabled": true,
      "userName": "sample string 10",
      "joinDate": "2025-05-20T15:55:09.3771609-05:00",
      "firstName": "sample string 12",
      "lastName": "sample string 13",
      "isSystemUser": true,
      "accountVerified": true,
      "acceptedTermsAndConditionsDate": "2025-05-20T15:55:09.3771609-05:00",
      "phoneNumber": "sample string 15",
      "roles": [],
      "claims": [],
      "logins": []
    }
  }
}

text/html

Sample:

{"id":1,"firstName":"sample string 2","lastName":"sample string 3","companyName":"sample string 4","phone":"sample string 5","email":"sample string 6","cellPhone":"sample string 7","isProspect":true,"addedDate":"2025-05-20T15:55:09.3751152-05:00","affiliateCode":"sample string 10","discountPercent":11.0,"isBuilder":true,"notes":"sample string 13","notificationsEnabled":true,"userPersonalInfoId":15,"userBusinessInfoId":16,"userPersonalInfo":{"id":1,"birthday":"2025-05-20T15:55:09.3771609-05:00","annualIncome":1.0,"isDisabled":true,"isVeteran":true,"returnYear":1,"disabilityLevel":1.0,"disabilityYear":1,"addedDate":"2025-05-20T15:55:09.3771609-05:00","lastModifiedDate":"2025-05-20T15:55:09.3771609-05:00","isOnActiveDuty":true},"userBusinessInfo":{"id":1,"companyName":"sample string 2","addressLine1":"sample string 3","city":"sample string 4","state":"sample string 5","zip":"sample string 6","countyId":7,"phone":"sample string 8","fax":"sample string 9","email":"sample string 10","cellPhone":"sample string 11","bio":"sample string 12","logo":"sample string 13","affiliateCode":"sample string 14","practiceStartYear":1,"onsiteAdEnabled":true,"docGenEnabled":true,"whiteLabelEnabled":true,"isPreferred":true,"starRating":19,"addedDate":"2025-05-20T15:55:09.3771609-05:00","lastModifiedDate":"2025-05-20T15:55:09.3771609-05:00","practiceArea":"sample string 21","discountPercent":22.0,"referrerAffiliateCode":"sample string 23","maxPropertyCount":1,"appealFeeOverride":1.0,"isTestUser":true,"individualGiftDiscount":25.0,"websiteUrl":"sample string 26","contingencyFee":1.0,"attorneyCode":"sample string 27","isBannerVisible":true,"clientColor":"sample string 29","clientLogo":"sample string 30","appealFeeAmount":31.0,"analysisFeeAmount":32.0,"referralFeeAmount":33.0,"forwardSiteReferrals":true,"referrealFeeToPtfAmount":35.0,"userReportIdentifier":"sample string 36","displayAppealDiscountBox":true,"displayHowToStartInstructions":true,"requireUserRegistration":true,"collectAnalysisFee":true,"iFrameBannerImageUrl":"sample string 41","customContactSectionTitle":"sample string 42","customContactSectionContent":"sample string 43","iFrameEmailReportToWebUser":true,"iFrameEnabledAppeal":true,"iFrameEnabledAppealGuarantee":true,"displayQrCode":true,"qrCodeUrl":"sample string 48","qrCodeClientUrl":"sample string 49","displayEngagementPageOnReport":true,"engagementPageContent":"sample string 51","digitalSignaturePackageUrl":"sample string 52","isPtfAttorney":true,"isBusinessReferralAttorney":true,"appealProcessingEnabled":true,"residentialAppealExemptionFilingFee":1.0,"vacancyConstructionIncomeAppealFilingFee":1.0,"certificateOfErrorFilingFee":1.0,"condoAssociationAppealFilingFee":1.0,"isFilingFeePerAppeal":true,"feeSharingPercent":1.0,"notes":"sample string 57","isProcessingIncluded":true,"isPerAdditionalAppealPricing":true,"userId":60,"user":{"id":1,"accessFailedCount":2,"email":"sample string 3","emailConfirmed":true,"lockoutEnabled":true,"lockoutEndDateUtc":"2025-05-20T15:55:09.3771609-05:00","passwordHash":"sample string 6","phoneNumberConfirmed":true,"securityStamp":"sample string 8","twoFactorEnabled":true,"userName":"sample string 10","joinDate":"2025-05-20T15:55:09.3771609-05:00","firstName":"sample string 12","lastName":"sample string 13","isSystemUser":true,"accountVerified":true,"acceptedTermsAndConditionsDate":"2025-05-20T15:55:09.3771609-05:00","phoneNumber":"sample string 15","roles":[],"claims":[],"logins":[]}}}

application/xml, text/xml

Sample:

<BusinessUserClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities">
  <Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
  <AddedDate>2025-05-20T15:55:09.3751152-05:00</AddedDate>
  <AffiliateCode>sample string 10</AffiliateCode>
  <CellPhone>sample string 7</CellPhone>
  <CompanyName>sample string 4</CompanyName>
  <DiscountPercent>11</DiscountPercent>
  <Email>sample string 6</Email>
  <FirstName>sample string 2</FirstName>
  <IsBuilder>true</IsBuilder>
  <IsProspect>true</IsProspect>
  <LastName>sample string 3</LastName>
  <Notes>sample string 13</Notes>
  <NotificationsEnabled>true</NotificationsEnabled>
  <Phone>sample string 5</Phone>
  <UserBusinessInfo>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
    <AddedDate>2025-05-20T15:55:09.3771609-05:00</AddedDate>
    <AddressLine1>sample string 3</AddressLine1>
    <AffiliateCode>sample string 14</AffiliateCode>
    <AnalysisFeeAmount>32</AnalysisFeeAmount>
    <AppealFeeAmount>31</AppealFeeAmount>
    <AppealFeeOverride>1</AppealFeeOverride>
    <AppealProcessingEnabled>true</AppealProcessingEnabled>
    <AttorneyCode>sample string 27</AttorneyCode>
    <Bio>sample string 12</Bio>
    <CellPhone>sample string 11</CellPhone>
    <CertificateOfErrorFilingFee>1</CertificateOfErrorFilingFee>
    <City>sample string 4</City>
    <ClientColor>sample string 29</ClientColor>
    <ClientLogo>sample string 30</ClientLogo>
    <CollectAnalysisFee>true</CollectAnalysisFee>
    <CompanyName>sample string 2</CompanyName>
    <CondoAssociationAppealFilingFee>1</CondoAssociationAppealFilingFee>
    <ContingencyFee>1</ContingencyFee>
    <CountyId>7</CountyId>
    <CustomContactSectionContent>sample string 43</CustomContactSectionContent>
    <CustomContactSectionTitle>sample string 42</CustomContactSectionTitle>
    <DigitalSignaturePackageUrl>sample string 52</DigitalSignaturePackageUrl>
    <DiscountPercent>22</DiscountPercent>
    <DisplayAppealDiscountBox>true</DisplayAppealDiscountBox>
    <DisplayEngagementPageOnReport>true</DisplayEngagementPageOnReport>
    <DisplayHowToStartInstructions>true</DisplayHowToStartInstructions>
    <DisplayQrCode>true</DisplayQrCode>
    <DocGenEnabled>true</DocGenEnabled>
    <Email>sample string 10</Email>
    <EngagementPageContent>sample string 51</EngagementPageContent>
    <Fax>sample string 9</Fax>
    <FeeSharingPercent>1</FeeSharingPercent>
    <ForwardSiteReferrals>true</ForwardSiteReferrals>
    <IFrameBannerImageUrl>sample string 41</IFrameBannerImageUrl>
    <IFrameEmailReportToWebUser>true</IFrameEmailReportToWebUser>
    <IFrameEnabledAppeal>true</IFrameEnabledAppeal>
    <IFrameEnabledAppealGuarantee>true</IFrameEnabledAppealGuarantee>
    <IndividualGiftDiscount>25</IndividualGiftDiscount>
    <IsBannerVisible>true</IsBannerVisible>
    <IsBusinessReferralAttorney>true</IsBusinessReferralAttorney>
    <IsFilingFeePerAppeal>true</IsFilingFeePerAppeal>
    <IsPerAdditionalAppealPricing>true</IsPerAdditionalAppealPricing>
    <IsPreferred>true</IsPreferred>
    <IsProcessingIncluded>true</IsProcessingIncluded>
    <IsPtfAttorney>true</IsPtfAttorney>
    <IsTestUser>true</IsTestUser>
    <LastModifiedDate>2025-05-20T15:55:09.3771609-05:00</LastModifiedDate>
    <Logo>sample string 13</Logo>
    <MaxPropertyCount>1</MaxPropertyCount>
    <Notes>sample string 57</Notes>
    <OnsiteAdEnabled>true</OnsiteAdEnabled>
    <Phone>sample string 8</Phone>
    <PracticeArea>sample string 21</PracticeArea>
    <PracticeStartYear>1</PracticeStartYear>
    <QrCodeClientUrl>sample string 49</QrCodeClientUrl>
    <QrCodeUrl>sample string 48</QrCodeUrl>
    <ReferralFeeAmount>33</ReferralFeeAmount>
    <ReferrealFeeToPtfAmount>35</ReferrealFeeToPtfAmount>
    <ReferrerAffiliateCode>sample string 23</ReferrerAffiliateCode>
    <RequireUserRegistration>true</RequireUserRegistration>
    <ResidentialAppealExemptionFilingFee>1</ResidentialAppealExemptionFilingFee>
    <StarRating>19</StarRating>
    <State>sample string 5</State>
    <User xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.AuthEntities">
      <AccessFailedCount xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">2</AccessFailedCount>
      <Email xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">sample string 3</Email>
      <EmailConfirmed xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">true</EmailConfirmed>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">1</Id>
      <LockoutEnabled xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">true</LockoutEnabled>
      <LockoutEndDateUtc xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">2025-05-20T15:55:09.3771609-05:00</LockoutEndDateUtc>
      <PasswordHash xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">sample string 6</PasswordHash>
      <PhoneNumber xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">sample string 15</PhoneNumber>
      <PhoneNumberConfirmed xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">true</PhoneNumberConfirmed>
      <SecurityStamp xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">sample string 8</SecurityStamp>
      <TwoFactorEnabled xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">true</TwoFactorEnabled>
      <UserName xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity.EntityFramework">sample string 10</UserName>
      <d3p1:AcceptedTermsAndConditionsDate>2025-05-20T15:55:09.3771609-05:00</d3p1:AcceptedTermsAndConditionsDate>
      <d3p1:AccountVerified>true</d3p1:AccountVerified>
      <d3p1:FirstName>sample string 12</d3p1:FirstName>
      <d3p1:IsSystemUser>true</d3p1:IsSystemUser>
      <d3p1:JoinDate>2025-05-20T15:55:09.3771609-05:00</d3p1:JoinDate>
      <d3p1:LastName>sample string 13</d3p1:LastName>
    </User>
    <UserId>60</UserId>
    <UserReportIdentifier>sample string 36</UserReportIdentifier>
    <VacancyConstructionIncomeAppealFilingFee>1</VacancyConstructionIncomeAppealFilingFee>
    <WebsiteUrl>sample string 26</WebsiteUrl>
    <WhiteLabelEnabled>true</WhiteLabelEnabled>
    <Zip>sample string 6</Zip>
  </UserBusinessInfo>
  <UserBusinessInfoId>16</UserBusinessInfoId>
  <UserPersonalInfo>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
    <AddedDate>2025-05-20T15:55:09.3771609-05:00</AddedDate>
    <AnnualIncome>1</AnnualIncome>
    <Birthday>2025-05-20T15:55:09.3771609-05:00</Birthday>
    <DisabilityLevel>1</DisabilityLevel>
    <DisabilityYear>1</DisabilityYear>
    <IsDisabled>true</IsDisabled>
    <IsOnActiveDuty>true</IsOnActiveDuty>
    <IsVeteran>true</IsVeteran>
    <LastModifiedDate>2025-05-20T15:55:09.3771609-05:00</LastModifiedDate>
    <ReturnYear>1</ReturnYear>
  </UserPersonalInfo>
  <UserPersonalInfoId>15</UserPersonalInfoId>
</BusinessUserClient>