PUT api/role/{id}/updateprice

Update price for a given PropertySalesRole. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

the id of the role

integer

Required

Body Parameters

UpdatePriceDataContract

UpdatePriceDataContract
NameDescriptionTypeAdditional information
AskingPrice

The asking price value.

decimal number

None.

PriceType

The price type value.

EnumDataContract

None.

PriceText

The price text value.

string

None.

PriceQualifierType

The price qualifier type value.

EnumDataContract

None.

MarkAsReduced

Indicates whether mark as reduced is true.

boolean

None.

PriceOnApplication

Indicates whether price on application is true.

boolean

None.

HomeReportPrice

The home report price value.

decimal number

None.

HomeReportPublishedDate

The home report published date, expressed as a date and time.

date

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "AskingPrice": 1.1,
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "PriceText": "sample string 2",
  "PriceQualifierType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "MarkAsReduced": true,
  "PriceOnApplication": true,
  "HomeReportPrice": 1.1,
  "HomeReportPublishedDate": "2026-07-23T08:20:34.6861553Z"
}

Response Information

Resource Description

The response returned after the operation completes.

UpdatePropertyPriceResponseDataContract
NameDescriptionTypeAdditional information
PriceChangeEventId

The unique identifier of the related price change event resource.

integer

None.

NewPrice

The new price value.

decimal number

None.

OldPrice

The old price value.

decimal number

None.

NewPriceType

The new price type value.

EnumDataContract

None.

OldPriceType

The old price type value.

EnumDataContract

None.

IsSuccessful

Indicates whether this item is successful.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "PriceChangeEventId": 1,
  "NewPrice": 1.1,
  "OldPrice": 2.1,
  "NewPriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "OldPriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "IsSuccessful": true
}