Scenario #1101: Add Phone Number To Contact Data

Given Properties

name	value
partnerName	Matthieu
phoneNumberKeyToAdd	mobile
phoneNumberToAdd	+49 152 1234567

partnerContactUuid

GET /api/hs/office/relations?relationType=PARTNER&personData=Matthieu
=> status: 200 OK 
[ {
  "uuid" : "dbcff45e-3b1b-41f8-ae26-1d114cc6b971",
  "anchor" : {
    "uuid" : "c6575205-1480-4b70-a30b-d0c5a1d7cc99", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "cc841e55-8c8a-4ed6-9182-1db104966aed", // Person: Michelle Matthieu
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michelle",
    "familyName" : "Matthieu"
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "bcc956de-51a8-460a-9b05-b693320bcb8f", // Contact: Michelle Matthieu
    "caption" : "Michelle Matthieu",
    "postalAddress" : {
      "city" : "Hamburg",
      "name" : "Michelle Matthieu",
      "street" : "An der Wandse 34",
      "country" : "Germany",
      "zipcode" : "22123"
    },
    "emailAddresses" : {
      "main" : "michelle@matthieu.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 40 123456"
    }
  }
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

Patch the Additional Phone-Number into the Contact

PATCH /api/hs/office/contacts/bcc956de-51a8-460a-9b05-b693320bcb8f // Contact: Michelle Matthieu
{
  "phoneNumbers" : {
    "mobile" : "+49 152 1234567"
  }
}
=> status: 200 OK 

Verify if the New Phone Number Got Added

GET /api/hs/office/relations?relationType=PARTNER&personData=Matthieu
=> status: 200 OK 
[ {
  "uuid" : "dbcff45e-3b1b-41f8-ae26-1d114cc6b971",
  "anchor" : {
    "uuid" : "c6575205-1480-4b70-a30b-d0c5a1d7cc99", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "cc841e55-8c8a-4ed6-9182-1db104966aed", // Person: Michelle Matthieu
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michelle",
    "familyName" : "Matthieu"
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "bcc956de-51a8-460a-9b05-b693320bcb8f", // Contact: Michelle Matthieu
    "caption" : "Michelle Matthieu",
    "postalAddress" : {
      "city" : "Hamburg",
      "name" : "Michelle Matthieu",
      "street" : "An der Wandse 34",
      "country" : "Germany",
      "zipcode" : "22123"
    },
    "emailAddresses" : {
      "main" : "michelle@matthieu.example.org"
    },
    "phoneNumbers" : {
      "mobile" : "+49 152 1234567",
      "office" : "+49 40 123456"
    }
  }
} ]

---

generated on 03-10-2025 12:07:39 for branch master