Skip to content

Create a contact

This method creates a contact address for an ImmobilienScout24 user.

POST /offer/v1.0/user/{username}/contact

Supported media types:
XML
JSON

Notes:

  • The telephone numbers can be entered in three separate parts (country code, area code (Ortsvorwahl) and telephone number) or as single input field but with the same separate field restrictions!
  • Country code (Ländervorwahl): „00“ is not allowed, it needs to be „+"
  • Area code (Regionvorwahl): if Countrycode = "+49", than we disallow an area code which starts with „0"
  • only 20 contacts with "showOnProfilePage" could be have the value "true"
  • External id which contains "/" needs to be url encoded
  • NEW: the field secondaryEmail allows realtors to receive their seeker leads to a second email inbox.
  • The contact data managed by this resource is used by our Branchenbuch and Image Boost products. If you're calling this endpoint on behalf of a customer who has booked the aforementioned products with ImmoScout24, please make sure to supply the businessCardContact flag within the request. This is important for consistency and the correct functioning of these products.

Request

Path Parameters

PARAMETER DESCRIPTION
Username the username which the user uses for logging in to www.immobilienscout24
me "me" can be used instead of the username, when the user is logged in by 3-legged OAuth

minimum XML: 

1
2
3
4
5
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:realtorContactDetail xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns4="http://rest.immobilienscout24.de/schema/customer/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/user/1.0" >
    <email>contactAddress@is24.de</email>
    <lastname>lastname</lastname>
</common:realtorContactDetail>

maximum 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
<?xml version="1.0" encoding="UTF-8"?>
<common:realtorContactDetail xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns4="http://rest.immobilienscout24.de/schema/customer/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/user/1.0" >
    <email>max.mustermann@immobilienscout24.de</email>
    <salutation>FEMALE</salutation>
    <firstname>Maxine</firstname>
    <lastname>Mustermann</lastname>
    <faxNumberCountryCode>+49</faxNumberCountryCode>
    <faxNumberAreaCode>30</faxNumberAreaCode>
    <faxNumberSubscriber>243010001</faxNumberSubscriber>
    <phoneNumberCountryCode>+49</phoneNumberCountryCode>
    <phoneNumberAreaCode>30</phoneNumberAreaCode>
    <phoneNumberSubscriber>243010001</phoneNumberSubscriber>
    <cellPhoneNumberCountryCode>+49</cellPhoneNumberCountryCode>
    <cellPhoneNumberAreaCode>179</cellPhoneNumberAreaCode>
    <cellPhoneNumberSubscriber>24301000</cellPhoneNumberSubscriber>
    <address>
        <street>Andreasstr.</street>
        <houseNumber>10</houseNumber>
        <postcode>10243</postcode>
        <city>Berlin</city>
    </address>
    <countryCode>DEU</countryCode>
    <title>Master</title>
    <additionName>HuiBuh</additionName>
    <company>ImmobilienScout24, field is no longer used or visible on the is24 website</company>
    <homepageUrl>http://www.immobilienscout24.de</homepageUrl>
    <position>position oder function in company</position>
    <secondaryEmail>secondary-email@example.com</secondaryEmail>
    <officeHours>Von 11:30 bis 12:00, dabei eine halbe Stunde Pause, field is no longer used or visible on the is24 website</officeHours>
    <defaultContact>false</defaultContact>
    <localPartnerContact>false</localPartnerContact>
    <businessCardContact>false</businessCardContact>
    <externalId>a-001</externalId>
    <showOnProfilePage>true</showOnProfilePage>   
</common:realtorContactDetail>

2nd option to send numbers (instead of the three separate fields): 

1
2
3
4
5
...
<faxNumber>+49 30 12345</faxNumber>
<phoneNumber>+49 30 54321</phoneNumber>
<cellPhoneNumber>+49 172 1234567</cellPhoneNumber>
...

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
{
  "common.realtorContactDetail" : {
    "email" : "company-email@example.com",
    "salutation" : "FEMALE",
    "firstname" : "Maxine",
    "lastname" : "Mustermann",
    "faxNumberCountryCode":"+49",
    "faxNumberAreaCode":"30",
    "faxNumberSubscriber":"24301111",
    "phoneNumberCountryCode" : "+49",
    "phoneNumberAreaCode" : "30",
    "phoneNumberSubscriber" : "243010000",
    "cellPhoneNumberCountryCode" : "+49" ,
    "cellPhoneNumberAreaCode" : "152",
    "cellPhoneNumberSubscriber": "123123" ,
    "address" : {
      "street" : "Andreasstr.",
      "houseNumber" : "10",
      "postcode" : "10243",
      "city" : "Berlin"
    },
    "countryCode" : "DEU",
    "title" : "Dr.",
    "additionName" : "HuiBuh" ,
    "company" : "ImmobilienScout24, field is no longer used or visible on the is24 website" ,
    "homepageUrl" : "http://www.immobilienscout24.de" ,
    "position" : "position oder function in company",
    "secondaryEmail" : "secondary-email@example.com",
    "officeHours" : "Von  11:30 bis 12:00, dabei eine halbe Stunde Pause, field is no longer used or visible on the is24 website" ,
    "defaultContact" : false,
    "localPartnerContact" : false,
    "businessCardContact" : false,
    "realEstateReferenceCount" : 1,
    "externalId" : "external-ID",
    "showOnProfilePage":"true"   
 }
}

Response

XML: 

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

JSON: 

1
2
3
4
5
6
7
8
9
{
    "common:messages": {
        "message": {
            "messageCode": "MESSAGE_RESOURCE_CREATED",
            "message": "Resource [contact] with id [123456] has been created.",
            "id": "123456"
        }
    }
}