Contact

Contact/PutbyID

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

https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username}/contact/{id}/

  • The contact id in the URI must match the contact id in the body.
  • The telephone numbers must always be entered in three separate parts (country code, area code (Ortsvorwahl), telephone number) (in contrast to the results of GET ALL or GET by ID)
  • These fields are mandatory: last name, surname and all address fields. From 8th January 2014, only last name and email address are mandatory.
  • Duplicate check (POST/PUT Contact) compares the following fields: salutation, first name, last name, street, housenumber, zip, city, country code, phone, fax, cell phone, homepage, email
  • Example for a PUT with an external ID: http://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username}/contact/ext-a001 changes the contact addresss with the external contact ID=a001
  • only 20 contacts with "showOnProfilePage" could be have the value "true"

Supported media types

  • XML (Accept: application/xml)
  • JSON (Accept: application/json)

Authorization requirements

A System Key and an authenticated user are required for this operation:

 

Please use a secure connection (https) for this operation.

Request

Path Parameters

  • Username or "me"
  • id: the contact id, which you got as a response on the POST contact request. Alternatively, it can be transmitted by body, but than it has to be identical to the id in the URI
  • externalId: the contact id of the rest api client system.
    • it must be unique within this user
    • it must have the Prefix "ext-". The rrefix is not part of the externalId, it only marks the text as "externalId"
    • it should be equal to the id in the Body, if available.

Query Parameters

none

Body

XML


<?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>24301000 1</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 more used or visible in the is24 website</company>
    <homepageUrl>http://www.immobilienscout24.de</homepageUrl>    
    <position>position oder taetigkeit im unternehmen</position>
    <officeHours>Von 11:30 bis 12:00, dabei eine halbe Stunde Pause, field is no more used or visible in the is24 website</officeHours>   
    <defaultContact>false</defaultContact>
    <localPartnerContact>false</localPartnerContact>
    <businessCardContact>false</businessCardContact>
    <realEstateReferenceCount>2</realEstateReferenceCount>
    <externalId>a-001</externalId>
    <showOnProfilePage>true</showOnProfilePage>      
</common:realtorContactDetail>

JSON

{
  "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 more used or visible in the is24 website" ,
    "homepageUrl" : "http://www.immobilienscout24.de" ,
    "position":"position oder taetigkeit im unternehmen",
    "officeHours" : "Von  11:30 bis 12:00, dabei eine halbe Stunde Pause, field is no more used or visible in the is24 website" ,
    "defaultContact" : false,
    "localPartnerContact" : false,
    "businessCardContact" : false,
    "realEstateReferenceCount" : 1,
    "externalId" : "a-001",
    "showOnProfilePage":"true"   
 }
}

Response

The following section includes the HTTP status code, a short description and examples for the response body content of a successful processed request.
Error responses as well as other simple message responses are described in detail within the common message responses.

 

Status 200 OK

The requested operation was successful.

Header

No special headers.

Body

XML

<?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

{
  "common.messages":[
    {
      "message":{
        "messageCode":"MESSAGE_RESOURCE_UPDATED",
        "message":"Resource [NAME] with id [ID] has been updated."
      }
    }
  ]
}