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

This method will create new web user record and add charge for that user to be paid at the later time

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Website Owner system user id

integer

Required

Body Parameters

New website visitor user model

WebUserBindingModel
NameDescriptionTypeAdditional information
FirstName

string

Required

LastName

string

Required

Phone

string

Required

Email

string

Required

ReferrerAffiliateCode

string

Required

ReferrerDomain

string

Required

Pin

string

Required

PurchasePrice

decimal number

None.

PurchaseDate

string

None.

AnalysisFee

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "firstName": "sample string 1",
  "lastName": "sample string 2",
  "phone": "sample string 3",
  "email": "sample string 4",
  "referrerAffiliateCode": "sample string 5",
  "referrerDomain": "sample string 6",
  "pin": "sample string 7",
  "purchasePrice": 1.0,
  "purchaseDate": "sample string 8",
  "analysisFee": 9.0
}

text/html

Sample:
{"firstName":"sample string 1","lastName":"sample string 2","phone":"sample string 3","email":"sample string 4","referrerAffiliateCode":"sample string 5","referrerDomain":"sample string 6","pin":"sample string 7","purchasePrice":1.0,"purchaseDate":"sample string 8","analysisFee":9.0}

application/xml, text/xml

Sample:
<WebUserBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.WebIntegration">
  <AnalysisFee>9</AnalysisFee>
  <Email>sample string 4</Email>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <Phone>sample string 3</Phone>
  <Pin>sample string 7</Pin>
  <PurchaseDate>sample string 8</PurchaseDate>
  <PurchasePrice>1</PurchasePrice>
  <ReferrerAffiliateCode>sample string 5</ReferrerAffiliateCode>
  <ReferrerDomain>sample string 6</ReferrerDomain>
</WebUserBindingModel>

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

Response Information

Resource Description

Instance of WebUserModel

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:35:10.3784604-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:35:10.3805098-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:35:10.3784604-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:35:10.3805098-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:35:10.3805098-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:35:10.3784604-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>