Skip to content

Update a Real Estate project

Update the resource "realestateproject" by Id

PUT /offer/v1.0/user/{username}/realestateproject/{realestateprojectid}

Supported media types:
XML
JSON

Request

Path Parameters

PARAMETER DESCRIPTION
Username the username which the user uses for logging in to www.immobilienscout24
Username "me" can be used instead of the username, when the user is logged in by 3-legged oauth
realestateprojectid the unique project ID, generated by IS24 when posting a real estate project

Body Values

The values that you are allowed to send are dependent on the project that you try to edit. We provide and OPTIONS call that returns a schema for the data. Some fields are read-only, i.e. you need to send their current value and can therefore not be changed. Fields that are mandatory are marked with an asterisk '*' and need to be included in every PUT request and need to be non-empty.

PARAMETER CONSTRAINTS
name* max. 40 characters
title* max. 100 characters
price.minimal* max. 9999999999999.99
price.maximal* max. 9999999999999.99
space.minimal* max. 99999999.99
space.maximal* max. 99999999.99
numberOfHousingUnit* max 9999
interiorQuality* enum: {NO_INFORMATION, LUXURY, SOPHISTICATED, NORMAL, SIMPLE}
freeFrom* max 50 characters
address.street max. 100 characters
address.houseNumber max. 30 characters
address.postcode max. 20 characters, read-only
address.city max. 50 characters, read-only
homepageUrl max. 500 characters
extProjectUrl max. 500 characters
customization.layoutColor RGB value in hexadecimal format, e.g. #abcdef
customization.announcement max. 500 characters
enabledContactFormFields.firstName boolean
enabledContactFormFields.address boolean
enabledContactFormFields.phone boolean
referenceNumber max. 20 characters
showroom.street max. 100 characters
showroom.houseNumber max. 30 characters
showroom.postcode max. 20 characters
showroom.city max. 50 characters>
salesProgress integer value in {0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100}
description max. 3000 characters
numberOfHousingUnitsDetails.apartmentCount integer
numberOfHousingUnitsDetails.houseCount integer
numberOfHousingUnitsDetails.commercialCount integer
interiorCharacteristics List of strings with minimal 3 entries, maximal 20 entries, each string can have 100 characters
interiorQualityDescription max. 1500 characters
locationDescription max. 2050 characters
rooms.minimal max. 9999
rooms.maximal max. 9999
companyName max. 100 characters
contact.lastName max. 50 characters, non-empty if contact is included in request
contact.firstName max. 30 characters, non-empty if contact is included in request
contact.email max. 300 characters, non-empty if contact is included in request
contact.phone max. 40 characters, non-empty if contact is included in request

XML:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<realestateproject:realEstateProject xmlns:realestateproject="http://rest.immobilienscout24.de/schema/offer/realestateproject/1.0" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" id="122160">
    <name>New Luxury Project</name>
    <title>New Luxury Project with garden view and smart home facilities</title>
    <price>
        <minimal>10000.00</minimal>
        <maximal>40000.00</maximal>
    </price>
    <space>
        <minimal>100.00</minimal>
        <maximal>200.00</maximal>
    </space>
    <minPriceProQm>134.00</minPriceProQm>
    <numberOfHousingUnit>50</numberOfHousingUnit>
    <interiorQuality>LUXURY</interiorQuality>
    <freeFrom>01.01.2021</freeFrom>
    <address>
        <street>Andreasstr.</street>
        <houseNumber>10</houseNumber>
        <postcode>10245</postcode>
        <city>Berlin</city>
    </address>
    <homepageUrl>http://hompage.com</homepageUrl>
    <description>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
    </description>
    <numberOfHousingUnitsDetails>
        <apartmentCount>30</apartmentCount>
        <houseCount>10</houseCount>
        <commercialCount>10</commercialCount>
    </numberOfHousingUnitsDetails>
    <interiorCharacteristics>
        <InteriorCharacteristic>smart home</InteriorCharacteristic>
        <InteriorCharacteristic>fireplace</InteriorCharacteristic>
        <InteriorCharacteristic>garden</InteriorCharacteristic>
        <InteriorCharacteristic>balcony</InteriorCharacteristic>
        <InteriorCharacteristic>terrace</InteriorCharacteristic>
        <InteriorCharacteristic>hard wood floors</InteriorCharacteristic>
    </interiorCharacteristics>
    <interiorQualityDescription>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</interiorQualityDescription>
    <locationDescription>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</locationDescription>
    <rooms>
        <minimal>1.0</minimal>
        <maximal>4.0</maximal>
    </rooms>
    <companyName>Company Name</companyName>
    <contact>
        <lastName>Mustermann</lastName>
        <firstName>Max</firstName>
        <email>max.mustermann@example.com</email>
        <phone>030 24301999</phone>
    </contact>
</realestateproject:realEstateProject>

JSON:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
{
  "realestateproject.realEstateProject":{
    "@id":"122160",
    "name":"New Luxury Project",
    "title":"New Luxury Project with garden view and smart home facilities",
    "price":{
      "minimal":10000,
      "maximal":40000
    },
    "space":{
      "minimal":100,
      "maximal":200
    },
    "minPriceProQm":134,
    "numberOfHousingUnit":50,
    "interiorQuality":"LUXURY",
    "freeFrom":"01.01.2021",
    "address":{
      "street":"Andreasstr.",
      "houseNumber":"10",
      "postcode":"10245",
      "city":"Berlin"
    },
    "homepageUrl":"http:\/\/hompage.com",
    "description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
    "numberOfHousingUnitsDetails":{
      "apartmentCount":30,
      "houseCount":10,
      "commercialCount":10
    },
    "interiorCharacteristics":[
      {
        "InteriorCharacteristic":[
          "smart home",
          "fireplace",
          "garden",
          "balcony",
          "terrace",
          "hard wood floors"
        ]
      }
    ]
    ,
    "interiorQualityDescription":"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
    "rooms":{
      "minimal":1,
      "maximal":4
    },
    "companyName":"Company Name",
    "contact":{
      "lastName":"Mustermann",
      "firstName":"Max",
      "email":"max.mustermann@example.com",
      "phone":"030 24301999"
    }
  }
}

Response

XML: 

1
2
3
4
5
6
7
8
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
    xmlns:xlink="http://www.w3.org/1999/xlink">
    <message>
        <messageCode>MESSAGE_RESOURCE_UPDATED</messageCode>
        <message>Resource [NAME] with id [ID] has been updated. </message>
    </message>
</common:messages>

JSON: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "common.messages":[
    {
      "message":{
        "messageCode":"MESSAGE_RESOURCE_UPDATED",
        "message":"Resource [NAME] with id [ID] has been updated."
      }
    }
  ]
}