Skip to content

Update a contact

Updates the resource identified by the following URL.This method changes the immoscout24 user contact address

PUT /offer/v1.0/user/{username}/contact/{id or ext-externalId}

Supported media types:
XML
JSON

Notes:

  • only "last name" and "email address" are mandatory
  • The contact id in the URI must match the contact id in the body (if present)
  • 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!
  • 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

id / externalId cannot be used at the same time.

PARAMETER DESCRIPTION
Username the username which the user uses for logging in to www.immobilienscout24.de
me "me" can be used instead of the username, when the user is logged in by 3-legged OAuth
id the unique Scout object id, which is generated with POST CONTACT, automatically
externalId the contact id of the rest api client. it must be unique for a user and must contain the prefix "ext-"

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>MALE</salutation>
    <firstname>Max</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>243010001</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 in the is24 website</company>
    <homepageUrl>http://www.immobilienscout24.de</homepageUrl>    
    <position>position oder taetigkeit im unternehmen</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 in the is24 website</officeHours>   
    <defaultContact>false</defaultContact>
    <localPartnerContact>false</localPartnerContact>
    <businessCardContact>false</businessCardContact>
    <externalId>a-001</externalId>
    <showOnProfilePage>true</showOnProfilePage>      
</common:realtorContactDetail>

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

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."
      }
    }
  ]
}