latestSwagger 2.02026-08-2193114213.9 KB

ae1e0fe6da1a

properties

Update an existing property

put/properties/{id}

Path parameters

idinteger required

Request body

additional_areastring
air_conditioningstring
alarm_systemstring
apartment_numberstring
apartment_typestring
auto_liftstring
aut_building_certificatesstring[]
balconystring
balcony_spacestring
barrier_freestring
base_rentstring
bathroomstring
bicycle_storageboolean
building_energy_rating_typestring
building_permissionstring
building_typestring
built_in_kitchenstring
cellarstring
cellar_spacenumber float
chimneystring
citystring
co2_emissionstring
co_ownership_sharestring
commercialization_typestring
compensation_costsstring
conditionstring
connected_loadstring
construction_phasestring
construction_typestring
construction_yearstring
contract_typestring
corridorstring
cost_balconystring
cost_liftstring
cost_otherstring
countrystring
courtagestring
courtage_notestring
crane_runway_loadstring
cubaturestring
depositstring
description_notestring
distance_to_airportstring
distance_to_airport_in_kmstring
distance_to_fmstring
distance_to_fm_in_kmstring
distance_to_mrsstring
distance_to_mrs_in_kmstring
distance_to_ptstring
distance_to_pt_in_kmstring
energy_certificate_availabilitystring
energy_certificate_creation_datestring
energy_certificate_construction_yearinteger
energy_certificate_end_datestring
energy_certificate_start_datestring
energy_consumption_contains_warm_waterstring
energy_efficiency_class'A_PLUS' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H'

Energy efficiency class (A_PLUS, A, B, ..., H)

equipment_technology_construction_yearinteger
exposee_idstring
financial_contributionstring
firing_typesstring
flat_share_suitablestring
floorstring
floor_loadstring
floor_positionstring
flooring_typestring
free_fromstring
free_untilstring
furnishing_notestring
garage_typestring
gardenstring
garden_spacestring
gfzstring
goods_liftstring
goods_lift_loadstring
grzstring
guest_toiletstring
hall_heightstring
has_canteenstring
has_furniturestring
heating_costsstring
heating_costs_in_service_chargestring
heating_type'SELF_CONTAINED_CENTRAL_HEATING' | 'STOVE_HEATING' | 'CENTRAL_HEATING' | 'COMBINED_HEAT_AND_POWER_PLANT' | 'ELECTRIC_HEATING' | 'DISTRICT_HEATING' | 'FLOOR_HEATING' | 'GAS_HEATING' | 'WOOD_PELLET_HEATING' | 'NIGHT_STORAGE_HEATER' | 'OIL_HEATING' | 'SOLAR_HEATING' | 'HEAT_PUMP'

Heating type (GAS, OIL, WATER, ...)

height_garagestring
house_numberstring
industrial_areastring
interior_qualitystring
internal_brokeragestring
investment_typestring
lan_cablesstring
last_refurbishmentstring
latnumber float

Latitude

length_garagestring
liftstring
living_spacestring
lngnumber float

Longitude

location_classification_typestring
location_notestring
lodger_flatstring
loggiastring
long_description_notestring
long_furnishing_notestring
long_location_notestring
long_other_notestring
laundry_roomboolean
maintenance_reservestring
marketing_type'BUY' | 'RENT'

whether to buy (BUY) or rent (RENT)

max_number_of_personsstring
max_rental_timestring
min_rental_timestring
monumentstring
net_floor_spacestring
non_smokerstring
number_of_apartmentsstring
number_of_balconiesstring
number_of_bath_roomsstring
number_of_bed_roomsstring
number_of_commercialsstring
number_of_ev_charginginteger
number_of_floorsstring
number_of_parking_spacesstring
number_of_roomsstring
number_of_terracesstring
number_of_unitsstring
number_seatsstring
object_typestring
other_costsstring
other_notestring
parking_space_numberstring
parking_space_pricestring
parking_space_typestring
parking_space_typesstring
pets_allowedstring
plot_areastring
plot_numberstring
plus_vatstring
pricestring
price_typestring
rampstring
recommended_use_typesstring
register_numberstring
rent_durationsstring
rent_subsidystring
rental_incomestring
rental_income_actualstring
rental_income_targetstring
rentedstring
rs_category'ROOF_STOREY' | 'LOFT' | 'MAISONETTE' | 'PENTHOUSE' | 'TERRACED_FLAT' | 'GROUND_FLOOR' | 'APARTMENT' | 'RAISED_GROUND_FLOOR' | 'HALF_BASEMENT' | 'ATTIKA' | 'OTHER' | 'SINGLE_FAMILY_HOUSE' | 'TWO_FAMILY_HOUSE' | 'TERRACE_HOUSE' | 'MID_TERRACE_HOUSE' | 'TERRACE_END_HOUSE' | 'END_TERRACE_HOUSE' | 'MULTI_FAMILY_HOUSE' | 'TOWNHOUSE' | 'FINCA' | 'BUNGALOW' | 'FARMHOUSE' | 'SEMIDETACHED_HOUSE' | 'VILLA' | 'CASTLE_MANOR_HOUSE' | 'SPECIAL_REAL_ESTATE' | 'TWIN_SINGLE_FAMILY_HOUSE' | 'SUMMER_RESIDENCE' | 'GARAGE' | 'STREET_PARKING' | 'CARPORT' | 'DUPLEX' | 'CAR_PARK' | 'UNDERGROUND_GARAGE' | 'DOUBLE_GARAGE' | 'OFFICE_LOFT' | 'STUDIO' | 'OFFICE' | 'OFFICE_FLOOR' | 'OFFICE_BUILDING' | 'OFFICE_CENTRE' | 'OFFICE_STORAGE_BUILDING' | 'SURGERY' | 'SURGERY_FLOOR' | 'SURGERY_BUILDING' | 'COMMERCIAL_CENTRE' | 'LIVING_AND_COMMERCIAL_BUILDING' | 'OFFICE_AND_COMMERCIAL_BUILDING' | 'BAR_LOUNGE' | 'CAFE' | 'CLUB_DISCO' | 'GUESTS_HOUSE' | 'TAVERN' | 'HOTEL' | 'HOTEL_RESIDENCE' | 'HOTEL_GARNI' | 'PENSION' | 'RESTAURANT' | 'SHOWROOM_SPACE' | 'HALL' | 'HIGH_LACK_STORAGE' | 'INDUSTRY_HALL' | 'INDUSTRY_HALL_WITH_OPEN_AREA' | 'COLD_STORAGE' | 'MULTIDECK_CABINET_STORAGE' | 'STORAGE_WITH_OPEN_AREA' | 'STORAGE_AREA' | 'STORAGE_HALL' | 'SERVICE_AREA' | 'SHIPPING_STORAGE' | 'REPAIR_SHOP' | 'SHOPPING_CENTRE' | 'FACTORY_OUTLET' | 'DEPARTMENT_STORE' | 'KIOSK' | 'STORE' | 'SELF_SERVICE_MARKET' | 'SALES_AREA' | 'SALES_HALL' | 'RESIDENCE' | 'FARM' | 'LEISURE_FACILITY' | 'COMMERCIAL_UNIT' | 'INDUSTRIAL_AREA' | 'NURSING_HOME' | 'ASSISTED_LIVING' | 'HORSE_FARM' | 'SPECIAL_ESTATE' | 'VINEYARD' | 'INVEST_FREEHOLD_FLAT' | 'INVEST_SINGLE_FAMILY_HOUSE' | 'INVEST_MULTI_FAMILY_HOUSE' | 'INVEST_LIVING_BUSINESS_HOUSE' | 'INVEST_HOUSING_ESTATE' | 'INVEST_MICRO_APARTMENTS' | 'INVEST_OFFICE_BUILDING' | 'INVEST_COMMERCIAL_BUILDING' | 'INVEST_OFFICE_AND_COMMERCIAL_BUILDING' | 'INVEST_SHOP_SALES_FLOOR' | 'INVEST_SUPERMARKET' | 'INVEST_SHOPPING_CENTRE' | 'INVEST_RETAIL_PARK' | 'INVEST_HOTEL' | 'INVEST_BOARDING_HOUSE' | 'INVEST_SURGERY_BUILDING' | 'INVEST_CLINIC' | 'INVEST_REHAB_CLINIC' | 'INVEST_MEDICAL_SERVICE_CENTER' | 'INVEST_INTEGRATION_ASSISTANCE' | 'INVEST_DAY_NURSERY' | 'INVEST_DAY_CARE' | 'INVEST_NURSING_HOME' | 'INVEST_ASSISTED_LIVING' | 'INVEST_COMMERCIAL_CENTRE' | 'INVEST_HALL_STORAGE' | 'INVEST_INDUSTRIAL_PROPERTY' | 'INVEST_CAR_PARK' | 'INVEST_PLOT' | 'INVEST_COMMERCIAL_UNIT' | 'INVEST_OTHER' | 'SHORT_TERM_APARTMENT' | 'SHORT_TERM_ROOM' | 'SHORT_TERM_HOUSE' | 'SHORT_TERM_FLAT' | 'TRADE_SITE'

see below for possible values (e.g. LOFT)

rs_type'APARTMENT' | 'HOUSE' | 'TRADE_SITE' | 'GARAGE' | 'OFFICE' | 'SHORT_TERM_ACCOMODATION' | 'GASTRONOMY' | 'INDUSTRY' | 'STORE' | 'SPECIAL_PURPOSE' | 'INVESTMENT' | 'FLAT_SHARE_ROOM' | 'ASSISTED_LIVING' | 'SENIOR_CARE'

see below for possible values (e.g. HOUSE)

saunastring
service_chargestring
shop_window_lengthstring
short_notestring
short_term_accomodation_typestring
smart_homeboolean
short_term_constructiblestring
site_constructible_typestring
site_development_typestring
sold_pricenumber float
start_rental_datestring
store_typestring
storeroomstring
streetstring
suitable_for_investmentboolean
summer_residence_practicalstring
supply_typestring
swimming_poolstring
tenancystring
titlestring
primary_outdoor_orientation'NORTH' | 'SOUTH' | 'WEST' | 'EAST'

Balcony/terrace orientation (NORTH, SOUTH, WEST, EAST)

energy_efficiency_valuestring
thermal_characteristic_electricitystring
thermal_characteristic_heatingstring
total_floor_spacestring
total_rentstring
usable_floor_spacestring
unit_idstring
utilization_trade_sitestring
window_shutterboolean
width_garagestring
winter_gardenstring
zip_codestring
project_idinteger
broker_idinteger
team_idinteger
property_status_idinteger
archivedboolean
regionstring
hide_addressboolean
currency'EUR' | 'USD' | 'CHF' | 'HUF' | 'AED' | 'CZK' | 'GBP'
sold_datestring date
property_space_valuenumber float
number_of_indoor_parking_spacesinteger
number_of_outdoor_parking_spacesinteger
group_idsinteger[]
broker_idsinteger[]
department_idsinteger[]
{"stackTrail":"components:schemas:putPropertiesId:properties:partial_custom_fields","oasType":"schema","type":"unknown","description":"An object containing custom fields and their values. Syntax: {\"my_custom_field\": \"my_custom_value\"}. If a value contains quotes, escape them, e.g. {\"my_custom_field\": \"example value \\\"key\\\": 0123\"}. Unknown custom field names return a validation_error."}

Response

Update an existing property

idstring
namestring
titlestring
unit_idstring
exposee_idstring
project_idstring
broker_idstring
archivedstring
tokenstring
streetstring
house_numberstring
zip_codestring
citystring
latstring
lngstring
countrystring
regionstring
hide_addressstring
location_namestring
property_space_valuestring
for_biddingstring
group_idsstring
property_status_idstring
price_on_inquirystring
marketing_typestring
object_typestring
rs_typestring
rs_categorystring
custom_fieldsobject
sold_datestring
sold_pricenumber float
total_commissionstring
internal_commissionstring
external_commissionstring
internal_commission_percentagestring
external_commission_percentagestring
valuation_pricestring
valuation_price_fromstring
valuation_price_tostring
openimmo_firstnamestring
openimmo_lastnamestring
openimmo_emailstring
openimmo_phonestring
short_addressstring
number_of_roomsinteger
priceinteger
base_rentinteger
living_spaceinteger
number_of_bed_roomsinteger
number_of_bath_roomsinteger
currencystring
free_fromstring
rentedboolean
construction_yearinteger
energy_certificate_construction_yearinteger
energy_efficiency_classstring
energy_efficiency_valuenumber float
thermal_characteristicnumber float
plot_areanumber float
additional_areanumber float
heating_costsnumber float
heating_typestring
addressstring
apartment_numberstring
building_energy_rating_typestring
conditionstring
courtagestring
courtage_notestring
depositstring
description_notestring
short_notestring
energy_certificate_availabilitystring
firing_typesstring
furnishing_notestring
land_registrystring
local_courtstring
location_notestring
long_description_notestring
long_furnishing_notestring
long_location_notestring
long_other_notestring
other_notestring
net_floor_spacenumber float
parking_space_pricenumber float
price_per_sqmnumber float
service_chargenumber float
total_rentnumber float
usable_floor_spacenumber float
warning_noticestring
system_warning_noticestring
floorstring
number_of_floorsinteger
number_of_parking_spacesinteger
number_of_ev_charginginteger
cellarboolean
balconyboolean
gardenboolean
suitable_for_investmentboolean
window_shutterboolean
bicycle_storageboolean
laundry_roomboolean
smart_homeboolean
guest_toiletboolean
kitchen_completeboolean
rampboolean
site_development_typestring
site_constructible_typestring
aut_building_certificatesstring[]
primary_outdoor_orientationstring
is24_idstring
is24_contact_idstring
translationsstring[]
documentsstring[]
linksstring[]
rent_subsidystring
maintenance_reservenumber float
fork_idsinteger[]
fork_idinteger
location_idinteger
public_expose_urlstring
created_atstring
updated_atstring