PUT api/web/client/{clientId}/user

This method will update overpayment amount and set analyzed property id on the webuser record. This will allow us to associate analysis ran to a specific web user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Site owner system user id

integer

Required

Body Parameters

Web user model

WebUserUpdatedBindingsModel
NameDescriptionTypeAdditional information
WebUserId

integer

None.

AnalyzedRecordId

integer

None.

OverpaymentAmount

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "webUserId": 1,
  "analyzedRecordId": 2,
  "overpaymentAmount": 3.0
}

text/html

Sample:
{"webUserId":1,"analyzedRecordId":2,"overpaymentAmount":3.0}

application/xml, text/xml

Sample:
<WebUserUpdatedBindingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.WebIntegration">
  <AnalyzedRecordId>2</AnalyzedRecordId>
  <OverpaymentAmount>3</OverpaymentAmount>
  <WebUserId>1</WebUserId>
</WebUserUpdatedBindingsModel>

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 'WebUserUpdatedBindingsModel'.

Response Information

Resource Description

OK

WebUserModel
NameDescriptionTypeAdditional information
Id

integer

None.

FirstName

string

None.

LastName

string

None.

Phone

string

None.

Email

string

None.

ReferrerAffiliateCode

string

None.

ReferrerWebsite

string

None.

Pin

string

None.

PurchasePrice

decimal number

None.

PurchaseDate

string

None.

AnalyzedPropertyId

integer

None.

CreatedDate

date

None.

Cart

WebUserCartModel

None.

AnalysisFeeBillingThresholdAmount

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "phone": "sample string 4",
  "email": "sample string 5",
  "referrerAffiliateCode": "sample string 6",
  "referrerWebsite": "sample string 7",
  "pin": "sample string 8",
  "purchasePrice": 1.0,
  "purchaseDate": "sample string 9",
  "analyzedPropertyId": 1,
  "createdDate": "2025-05-20T14:36:26.4244798-05:00",
  "cart": {
    "id": 1,
    "propertyPin": "sample string 2",
    "propertyPurchasePrice": 1.0,
    "propertyPurchaseDate": "sample string 3",
    "analysisFeeAmount": 4.0,
    "webUserId": 5,
    "createdDate": "2025-05-20T14:36:26.4244798-05:00"
  },
  "analysisFeeBillingThresholdAmount": 10.0
}

text/html

Sample:
{"id":1,"firstName":"sample string 2","lastName":"sample string 3","phone":"sample string 4","email":"sample string 5","referrerAffiliateCode":"sample string 6","referrerWebsite":"sample string 7","pin":"sample string 8","purchasePrice":1.0,"purchaseDate":"sample string 9","analyzedPropertyId":1,"createdDate":"2025-05-20T14:36:26.4244798-05:00","cart":{"id":1,"propertyPin":"sample string 2","propertyPurchasePrice":1.0,"propertyPurchaseDate":"sample string 3","analysisFeeAmount":4.0,"webUserId":5,"createdDate":"2025-05-20T14:36:26.4244798-05:00"},"analysisFeeBillingThresholdAmount":10.0}

application/xml, text/xml

Sample:
<WebUserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.WebIntegration">
  <AnalysisFeeBillingThresholdAmount>10</AnalysisFeeBillingThresholdAmount>
  <AnalyzedPropertyId>1</AnalyzedPropertyId>
  <Cart>
    <AnalysisFeeAmount>4</AnalysisFeeAmount>
    <CreatedDate>2025-05-20T14:36:26.4244798-05:00</CreatedDate>
    <Id>1</Id>
    <PropertyPin>sample string 2</PropertyPin>
    <PropertyPurchaseDate>sample string 3</PropertyPurchaseDate>
    <PropertyPurchasePrice>1</PropertyPurchasePrice>
    <WebUserId>5</WebUserId>
  </Cart>
  <CreatedDate>2025-05-20T14:36:26.4244798-05:00</CreatedDate>
  <Email>sample string 5</Email>
  <FirstName>sample string 2</FirstName>
  <Id>1</Id>
  <LastName>sample string 3</LastName>
  <Phone>sample string 4</Phone>
  <Pin>sample string 8</Pin>
  <PurchaseDate>sample string 9</PurchaseDate>
  <PurchasePrice>1</PurchasePrice>
  <ReferrerAffiliateCode>sample string 6</ReferrerAffiliateCode>
  <ReferrerWebsite>sample string 7</ReferrerWebsite>
</WebUserModel>