Skip to content

Dossier Update

PUT dossiers/<dossier_id>

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

PATCH dossiers/<dossier_id>

Updates the dossier specified in the request path by merging the fields with the ones provided. There are no mandatory fields in the request, as long as the end result complies with the schema below.

PUT Request#

curl -X PUT 'https://api.pricehubble.com/api/v1/dossiers/119a6ead-4ac4-4b4b-b264-195a2895618e' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -d '{
  "title": "My dossier",
  "description": "My description",
  "dealType": "sale",
  "property": {
    "location": {
      "address": {
        "postCode": "8037",
        "city": "Zurich",
        "street": "Nordstrasse",
        "houseNumber": "391"
      },
      "coordinates": {
        "latitude": 47.3968601,
        "longitude": 8.5153549
      }
    },
    "propertyType": {
      "code": "house",
      "subcode": "house_detached"
    },
    "buildingYear": 1990,
    "livingArea": 100.00,
    "landArea": 900.00,
    "volume": 900.00,
    "numberOfRooms": 3,
    "numberOfBathrooms": 1,
    "numberOfIndoorParkingSpaces": 0,
    "numberOfOutdoorParkingSpaces": 0,
    "hasPool": true,
    "condition": {
      "bathrooms": "renovation_needed",
      "kitchen": "renovation_needed",
      "flooring": "well_maintained",
      "windows": "new_or_recently_renovated"
    },
    "quality": {
      "bathrooms": "simple",
      "kitchen": "normal",
      "flooring": "high_quality",
      "windows": "luxury"
    }
  },
  "userDefinedFields": [
    {
      "label": "Extra garage",
      "value": "Yes"
    }
  ],
  "images": [
    {
      "filename": "633390e8-0455-4520-87ba-3c5c8c234cb3.jpg",
      "caption": "Front view"
    }
  ],
  "logo": "b7219677-f4d5-4e99-9d7f-7cf1dee68900.png",
  "roomTourLink": "https://example.com",
  "countryCode": "CH"
}'

PATCH Request#

curl -X PATCH 'https://api.pricehubble.com/api/v1/dossiers/119a6ead-4ac4-4b4b-b264-195a2895618e' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -d '{
  "title": "My dossier",
  "description": "My description"
}'
Field Description Type Remarks
title Dossier title string
description Dossier description string Maximum of 2000 characters
dealType Deal type of the dossier string Valid values are sale or rent. Not providing this field makes the Dossier support both sale and rent types. Not accepted for multi_family_house property type code.
property Information about the property Property The location of a dossier’s property cannot be updated. Please create a new dossier if you want a dossier with a different location.
property.propertyType.code Property type PropertyType JP: house is only supported if dealType is sale
askingSalePrice Asking price in the main currency of the dossier’s country. The asking price will show up in dossier permalinks (see Dossier Sharing). integer Only relevant if dealType is sale
valuationOverrideSalePrice Custom sale price valuation that overrides PriceHubble's valuation integer Only relevant if dealType is sale
valuationOverrideSalePriceRange Custom sale price valuation range that overrides PriceHubble's valuation LowerUpperBound Only relevant if dealType is sale
valuationOverrideRentNet Custom net rent valuation that overrides PriceHubble's valuation integer Only relevant if dealType is rent
valuationOverrideRentNetRange Custom net rent valuation range that overrides PriceHubble's valuation LowerUpperBound Only relevant if dealType is rent
valuationOverrideRentGross Custom gross rent valuation that overrides PriceHubble's valuation integer Only relevant if dealType is rent
valuationOverrideRentGrossRange Custom gross rent valuation range that overrides PriceHubble's valuation LowerUpperBound Only relevant if dealType is rent
userDefinedFields User Defined Fields array of User Defined Fields max items: 12
images Dossier images array of Dossier Images max items: 20
logo Dossier logo filename string Get the filename from Dossier Logos endpoint
roomTourLink Url for virtual tour of the property string Only valid URLs are accepted
priceStrategyDescription User generated information about the price strategy string
selectedOffers The list of selected offer for this dossier array of strings example: ['05d9ab4', '18453de'] Deprecated since 2021-12-27. Use selectedSaleOffers or selectedRentOffers instead.
selectedSaleOffers The list of selected sale offers for this dossier array of strings example: ['05d9ab4', '18453de']
selectedRentOffers The list of selected rent offers for this dossier array of strings example: ['05d9ab4', '18453de']
selectedTransactions The list of selected transaction for this dossier array of strings example: ['05d9ab4', '18453de']
countryCode ISO country code string