Properties

Update Property

Edit nickname, purchase price, mortgage balance, postcode, UPRN, or the manual value override. A postcode change re-resolves the location and re-warms the index cache; a UPRN change attempts a PMI valuation when entitled.

patch/api/properties/{property_id}

Request

  • Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.earmarkiq.app/api/properties/{property_id}
  • Auth: HTTP bearer

Path parameters

property_idstring uuid required

Request body

nicknamestring nullable
postcodestring nullable
uprnstring nullable
clear_manual_valueboolean

Response

Successful Response

idstring required
nicknamestring nullable required
postcodestring required
admin_districtstring nullable required
regionstring nullable required
property_typestring required
purchase_pricenumber required
purchase_monthstring required
mortgage_balancenumber nullable required
estimated_valuenumber nullable required
equitynumber nullable required
index_month_usedstring nullable required
location_level_usedstring nullable required
is_activeboolean required
created_atstring required
attributionstring required
valuation_sourcestring nullable
valuation_datestring nullable
valuation_confidencestring nullable
valuation_lower_boundstring nullable
valuation_upper_boundstring nullable
manual_valuenumber nullable
uprnstring nullable
value_labelstring nullable
needs_valueboolean
pmi_verdictstring nullable
pmi_rejected_reasonstring nullable
pmi_checked_atstring nullable
pmi_estimate_seennumber nullable
pmi_estimate_confidencestring nullable
pmi_estimate_lower_boundnumber nullable
pmi_estimate_upper_boundnumber nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.