Kontakt aktualisieren
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Aktualisieren sie die Eigenschaften des Kontaktobjekts.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Globaler Dienst | US Government L4 | US Government L5 (DOD) | China, betrieben von 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Berechtigungen
Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie unter Berechtigungen.
Berechtigungstyp | Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten) |
---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | Contacts.ReadWrite |
Delegiert (persönliches Microsoft-Konto) | Contacts.ReadWrite |
Anwendung | Contacts.ReadWrite |
HTTP-Anforderung
Ein Kontakt aus dem standardmäßigen contactFolder des Benutzers.
PATCH /me/contacts/{id}
PATCH /users/{id | userPrincipalName}/contacts/{id}
Ein Kontakt aus dem contactFolder oberster Ebene eines Benutzers.
PATCH /me/contactFolders/{id}/contacts/{id}
PATCH /users/{id | userPrincipalName}/contactFolders/{id}/contacts/{id}
Ein Kontakt , der in einem untergeordneten Ordner eines contactFolder enthalten ist. befinden.
PATCH /me/contactFolders/{id}/childFolders/{id}/.../contacts/{id}
PATCH /users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts/{id}
Anforderungsheader
Kopfzeile | Wert |
---|---|
Authorization | Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung. |
Content-Type | application/json. Erforderlich. |
Anforderungstext
Geben Sie im Anforderungstext die Werte für die relevanten Felder an, die aktualisiert werden sollen. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet. Aus Gründen der Leistung sollten Sie vorhandene Werte, die nicht geändert wurden, nicht angeben.
Eigenschaft | Typ | Beschreibung |
---|---|---|
assistantName | String | Der Name des Assistenten des Kontakts. |
birthday | DateTimeOffset | Das Geburtsdatum des Kontakts. |
categories | String | Die Kategorien, die mit dem Kontakt verknüpft sind. |
children | String | |
CompanyName | String | Der Name des Unternehmens des Kontakts. |
department | String | Die Abteilung des Kontakts. |
displayName | String | Der Anzeigename des Kontakts. Beachten Sie, dass spätere Aktualisierungen an anderen Eigenschaften dazu führen können, dass der von Ihnen angegebene displayName-Wert von einem automatisch generierten Wert überschrieben wird. Um einen bereits vorhandenen Wert beizubehalten, fügen Sie diesen immer als displayName in einen Update-Vorgang ein. |
emailAddresses | typedEmailAddress-Sammlung | Die E-Mail-Adressen des Kontakts. |
fileAs | String | Der Name, unter dem der Kontakt abgelegt ist. |
gender | String | Das Geschlecht des Kontakts. |
generation | String | Die Generation des Kontakts. |
givenName | String | Der Vorname des Kontakts. |
imAddresses | String | Instant Messaging Chatadressen des Kontakts. |
initials | String | Die Initialen des Kontakts. |
jobTitle | String | Die Position des Kontakts. |
manager | String | Der Name des Vorgesetzten des Kontakts. |
middleName | String | Der zweite Vorname des Kontakts. |
nickName | String | Der Spitzname des Kontakts. |
officeLocation | String | Der Bürostandort des Kontakts. |
parentFolderId | String | Die ID des übergeordneten Ordners des Kontakts. |
personalNotes | String | Die Notizen des Benutzers zu dem Kontakt. |
phones | phone-Sammlung | Telefonnummern, die dem Kontakt zugeordnet sind, z. B. Privattelefon, Mobiltelefon und Geschäftstelefon. |
postalAddresses | physicalAddress-Sammlung | Dem Kontakt zugeordnete Adressen, z. B. Privatadresse und Geschäftsadresse. |
profession | String | Der Beruf des Kontakts. |
spouseName | Zeichenfolge | Der Name des Ehepartners/Partners des Kontakts |
surname | String | Der Nachname des Kontakts. |
title | String | Der Titel des Kontakts. |
websites | website-Sammlung | Websites, die dem Kontakt zugeordnet sind. |
weddingAnniversary | Datum | Der Hochzeitstag des Kontakts. |
yomiCompanyName | String | Der phonetische japanische Firmenname des Kontakts. Diese Eigenschaft ist optional. |
yomiGivenName | String | Der phonetische japanische Vorname des Kontakts. Diese Eigenschaft ist optional. |
yomiSurname | String | Der phonetische japanische Nachname des Kontakts. Diese Eigenschaft ist optional. |
Da die KontaktressourceErweiterungen unterstützt, können Sie den PATCH
Vorgang verwenden, um ihre eigenen App-spezifischen Daten in benutzerdefinierten Eigenschaften einer Erweiterung in einem vorhandenen Kontakt instance hinzuzufügen, zu aktualisieren oder zu löschen.
Antwort
Bei erfolgreicher Ausführung gibt die Methode einen Antwortcode und ein 200 OK
aktualisiertes Kontaktobjekt im Antworttext zurück.
Beispiel
Anforderung
Im folgenden Beispiel wird die persönliche E-Mail-Adresse des angegebenen Kontakts aktualisiert.
PATCH https://graph.microsoft.com/beta/me/contacts/AAMkADh6v5AAAvgTCEAAA=
Content-type: application/json
{
"emailAddresses":[
{
"type":"personal",
"name":"Pavel Bansky",
"address":"pavelb@contoso.com"
},
{
"address": "pavelb@contoso.com",
"name": "Pavel Bansky",
"type": "other",
"otherLabel": "Volunteer work"
}
]
}
Antwort
Das folgende Beispiel zeigt die Antwort. Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt sein.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#users('c3e1fcd2-db78-42a8-aec5-1f2cd59abb5c')/contacts/$entity",
"@odata.etag":"W/\"EQAAABYAAACv7At+UNVFRLhGciJGF6v5AAAve7fh\"",
"id":"AAMkADh6v5AAAvgTCEAAA=",
"createdDateTime":"2018-06-11T19:56:07Z",
"lastModifiedDateTime":"2018-06-11T20:26:23Z",
"changeKey":"EQAAABYAAACv7At+UNVFRLhGciJGF6v5AAAve7fh",
"categories":[
],
"parentFolderId":"AAMkADh6v5AAAAAAEOAAA=",
"birthday":null,
"fileAs":"",
"displayName":"Pavel Bansky",
"givenName":"Pavel",
"initials":null,
"middleName":null,
"nickName":null,
"surname":"Bansky",
"title":null,
"yomiGivenName":null,
"yomiSurname":null,
"yomiCompanyName":null,
"generation":null,
"imAddresses":[
],
"jobTitle":null,
"companyName":null,
"department":null,
"officeLocation":null,
"profession":null,
"assistantName":null,
"manager":null,
"spouseName":null,
"personalNotes":"",
"children":[
],
"gender":null,
"isFavorite":null,
"emailAddresses":[
{
"type":"personal",
"name":"Pavel Bansky",
"address":"pavelb@contoso.com"
},
{
"type":"other",
"otherLabel":"Volunteer work",
"name":"Pavel Bansky",
"address":"pavelb@contoso.com"
}
],
"websites":[
],
"phones":[
{
"type":"business",
"number":"+1 732 555 0102"
}
],
"postalAddresses":[
],
"flag":{
"flagStatus":"notFlagged"
}
}