Dossier Comparables

PUT dossiers/<dossier_id>/comparables

Updates the dossier specified in the request path by replacing the comparables with the ones provided.

Example Request#

curl -X PUT 'https://api.pricehubble.com/api/v1/dossiers/119a6ead-4ac4-4b4b-b264-195a2895618e/comparables' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -d '{
  "selectedSaleOffers": [
    "c30abfcd2589163deb8b784aac55296fb90f57c24b4dc13c7507d6eb0caebf79",
    "83577522dff3bac0d5b206b1be42a3e4bd30bd8acb2127252e5093b0b78ea54b",
    "ac5f0dd74fdb7f98234cd74a156cd8ec26b83ca320ae39198ebe193a51894772"
  ],
  "selectedRentOffers": [
    "7b773d61bcf5276513d89840e1012761146ca51fa4c1ec5a34c9f020fcd33ecc",
    "48a5d7118fae16e3ef8c063d394e69dd8a8920c3402e447913c8b37116003c04",
    "aa531c713520b41f4bad16dd2162574d963d3fa8629c6b8ffa33d2e1cefbc12f"
  ],
  "selectedTransactions": [
    "8cdaf159081216f01d36519067124bfead6112a96b47ba0a2326c601b0b2e6be",
    "b1dd1a9b610effa4ce88d06d1be19f72d7e5b953eb4fb525dd5d4b0aa68d074a",
    "f2dd4d5520cd2b398c347ef7955972d2271d6ef2e6ccd9a0d3e712f515ad1a4f"
  ],
  "useSelectedOffers": true,
  "useSelectedTransactions": true
}'

Request fields#

Field	Description	Type
selectedSaleOffers	The list of selected sale offers for this dossier	array of strings (24 items max)
selectedRentOffers	The list of selected rent offers for this dossier	array of strings (24 items max)
selectedTransactions	The list of selected transaction for this dossier	array of strings (24 items max)
useSelectedOffers	Display only `selectedSaleOffers` and `selectedRentOffers` as offers in the shared Dossier and PDF	boolean
useSelectedTransactions	Display only `selectedTransactions` as transactions in the shared Dossier and PDF	boolean