Mettre à jour un contact

Espace de noms: microsoft.graph

Mettez à jour les propriétés d’un objet contact.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation	Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire)	Contacts.ReadWrite
Déléguée (compte Microsoft personnel)	Contacts.ReadWrite
Application	Contacts.ReadWrite

Requête HTTP

Élément contact de l’élément contactFolder par défaut d’un utilisateur .

PATCH /me/contacts/{id}
PATCH /users/{id | userPrincipalName}/contacts/{id}

Élément contact de l’élément contactFolder de niveau supérieur d’un utilisateur .

PATCH /me/contactFolders/{id}/contacts/{id}
PATCH /users/{id | userPrincipalName}/contactFolders/{id}/contacts/{id}

Élément contact contenu dans un dossier enfant d’un élément contactFolder. L’exemple suivant montre un niveau d’imbrication, mais un contact peut se trouver dans un enfant d’un enfant, et ainsi de suite.

PATCH /me/contactFolders/{id}/childFolders/{id}/.../contacts/{id}
PATCH /users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts/{id}

En-têtes de demande

En-tête	Valeur
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez les valeurs pour les champs appropriés qui doivent être mis à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conserveront leurs valeurs précédentes ou seront recalculées en fonction des modifications apportées à d’autres valeurs des propriétés. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas été modifiées.

Lorsque vous mettez à jour des propriétés structurées telles que homeAddress, vous devez transmettre le jeu de propriétés complet.

Propriété	Type	Description
assistantName	Chaîne	Nom de l’assistant du contact.
birthday	DateTimeOffset	Anniversaire du contact.
businessAddress	PhysicalAddress	Adresse professionnelle du contact.
businessHomePage	Chaîne	Page d’accueil professionnelle du contact.
businessPhones	Chaîne	Numéros de téléphone professionnels du contact.
categories	Chaîne	Catégories associés au contact.
children	Chaîne	Noms des enfants du contact.
CompanyName	Chaîne	Nom de la société du contact.
department	Chaîne	Département du contact.
displayName	Chaîne	Nom d’affichage du contact. Notez que des mises à jour ultérieures d’autres propriétés peuvent avoir pour effet qu’une valeur générée automatiquement remplace la valeur displayName que vous avez spécifiée. Pour conserver une valeur préexistante, incluez-la toujours en tant que displayName dans une opération de mise à jour.
emailAddresses	collection EmailAddress	Adresses e-mail du contact.
fileAs	Chaîne	Nom sous lequel le contact est classé.
generation	Chaîne	Génération du contact.
givenName	Chaîne	Nom du contact donné.
homeAddress	PhysicalAddress	Adresse personnelle du contact.
homePhones	Collection de chaînes	Numéros de téléphone personnels du contact.
imAddresses	Chaîne	Adresses de messagerie instantanée du contact.
initials	Chaîne	Initiales du contact.
jobTitle	Chaîne	Fonction du contact.
manager	Chaîne	Nom du responsable du contact.
middleName	Chaîne	Deuxième prénom du contact.
mobilePhone	Chaîne	Numéro de téléphone mobile du contact.
nickName	Chaîne	Surnom du contact.
officeLocation	Chaîne	Emplacement du bureau du contact.
otherAddress	PhysicalAddress	Autres adresses du contact.
parentFolderId	Chaîne	ID du dossier parent du contact.
personalNotes	Chaîne	Notes de l’utilisateur sur le contact.
profession	Chaîne	Profession du contact.
spouseName	String	Nom du conjoint/partenaire du contact.
surname	Chaîne	Nom de famille du contact.
title	Chaîne	Titre du contact.
yomiCompanyName	Chaîne	Nom phonétique de la société japonaise du contact. Cette propriété est facultative.
yomiGivenName	Chaîne	Nom donné (prénom) phonétique japonais du contact. Cette propriété est facultative.
yomiSurname	Chaîne	Nom de famille (nom) japonais phonétique du contact. Cette propriété est facultative.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet contact mis à jour dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

HTTP

PATCH https://graph.microsoft.com/v1.0/me/contacts/{id}
Content-type: application/json

{
  "homeAddress": {
    "street": "123 Some street",
    "city": "Seattle",
    "state": "WA",
    "postalCode": "98121"
  },
  "birthday": "1974-07-22"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Contact
{
	HomeAddress = new PhysicalAddress
	{
		Street = "123 Some street",
		City = "Seattle",
		State = "WA",
		PostalCode = "98121",
	},
	Birthday = DateTimeOffset.Parse("1974-07-22"),
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Contacts["{contact-id}"].PatchAsync(requestBody);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users contacts patch --user-id {user-id} --contact-id {contact-id} --body '{\
  "homeAddress": {\
    "street": "123 Some street",\
    "city": "Seattle",\
    "state": "WA",\
    "postalCode": "98121"\
  },\
  "birthday": "1974-07-22"\
}\
'

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

import (
	  "context"
	  "time"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewContact()
homeAddress := graphmodels.NewPhysicalAddress()
street := "123 Some street"
homeAddress.SetStreet(&street) 
city := "Seattle"
homeAddress.SetCity(&city) 
state := "WA"
homeAddress.SetState(&state) 
postalCode := "98121"
homeAddress.SetPostalCode(&postalCode) 
requestBody.SetHomeAddress(homeAddress)
birthday , err := time.Parse(time.RFC3339, "1974-07-22")
requestBody.SetBirthday(&birthday) 

contacts, err := graphClient.Me().Contacts().ByContactId("contact-id").Patch(context.Background(), requestBody, nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Contact contact = new Contact();
PhysicalAddress homeAddress = new PhysicalAddress();
homeAddress.setStreet("123 Some street");
homeAddress.setCity("Seattle");
homeAddress.setState("WA");
homeAddress.setPostalCode("98121");
contact.setHomeAddress(homeAddress);
OffsetDateTime birthday = OffsetDateTime.parse("1974-07-22");
contact.setBirthday(birthday);
Contact result = graphClient.me().contacts().byContactId("{contact-id}").patch(contact);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const contact = {
  homeAddress: {
    street: '123 Some street',
    city: 'Seattle',
    state: 'WA',
    postalCode: '98121'
  },
  birthday: '1974-07-22'
};

await client.api('/me/contacts/{id}')
	.update(contact);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Contact;
use Microsoft\Graph\Generated\Models\PhysicalAddress;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Contact();
$homeAddress = new PhysicalAddress();
$homeAddress->setStreet('123 Some street');
$homeAddress->setCity('Seattle');
$homeAddress->setState('WA');
$homeAddress->setPostalCode('98121');
$requestBody->setHomeAddress($homeAddress);
$requestBody->setBirthday(new \DateTime('1974-07-22'));

$result = $graphServiceClient->me()->contacts()->byContactId('contact-id')->patch($requestBody)->wait();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.PersonalContacts

$params = @{
	homeAddress = @{
		street = "123 Some street"
		city = "Seattle"
		state = "WA"
		postalCode = "98121"
	}
	birthday = [System.DateTime]::Parse("1974-07-22")
}

# A UPN can also be used as -UserId.
Update-MgUserContact -UserId $userId -ContactId $contactId -BodyParameter $params

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.contact import Contact
from msgraph.generated.models.physical_address import PhysicalAddress

graph_client = GraphServiceClient(credentials, scopes)

request_body = Contact(
	home_address = PhysicalAddress(
		street = "123 Some street",
		city = "Seattle",
		state = "WA",
		postal_code = "98121",
	),
	birthday = "1974-07-22",
)

result = await graph_client.me.contacts.by_contact_id('contact-id').patch(request_body)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "AAMkAGI2THk0AAA=",
  "createdDateTime": "2014-10-19T23:08:24Z",
  "lastModifiedDateTime": "2014-10-19T23:08:24Z",
  "changeKey": "EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4",
  "categories": [],
  "parentFolderId": "AAMkAGI2AAEOAAA=",
  "birthday": "1974-07-22",
  "fileAs": "Fort, Garth",
  "displayName": "Garth Fort",
  "givenName": "Garth",
  "initials": "G.F.",
  "middleName": null,
  "nickName": "Garth",
  "surname": "Fort",
  "title": null,
  "yomiGivenName": null,
  "yomiSurname": null,
  "yomiCompanyName": null,
  "generation": null,
  "emailAddresses": [
    {
      "name": "Garth",
      "address": "garth@contoso.com"
    }
  ],
  "imAddresses": [
    "sip:garthf@contoso.com"
  ],
  "jobTitle": "Web Marketing Manager",
  "companyName": "Contoso, Inc.",
  "department": "Sales & Marketing",
  "officeLocation": "20/1101",
  "profession": null,
  "businessHomePage": "https://www.contoso.com",
  "assistantName": null,
  "manager": null,
  "homePhones": [],
  "mobilePhone": null,
  "businessPhones": [
    "+1 918 555 0101"
  ],
  "homeAddress": {
    "street": "123 Some street",
    "city": "Seattle",
    "state": "WA",
    "postalCode": "98121"
  },
  "businessAddress": {
      "street": "10 Contoso Way",
      "city": "Redmond",
      "state": "WA",
      "countryOrRegion": "USA",
      "postalCode": "98075"
  },
  "otherAddress": {},
  "spouseName": null,
  "personalNotes": null,
  "children": []
}