Mettre à jour un contact
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta
dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Mettez à jour les propriétés de l’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
Contact ducontactFolder par défaut de l’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 changé.
Propriété | Type | Description |
---|---|---|
assistantName | Chaîne | Nom de l’assistant du contact. |
birthday | DateTimeOffset | Anniversaire du contact. |
categories | Chaîne | Catégories associés au contact. |
children | Chaîne | |
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 typedEmailAddress | Adresses e-mail du contact. |
fileAs | Chaîne | Nom sous lequel le contact est classé. |
gender | Chaîne | Sexe du contact. |
generation | Chaîne | Génération du contact. |
givenName | Chaîne | Nom du contact donné. |
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. |
nickName | Chaîne | Surnom du contact. |
officeLocation | Chaîne | Emplacement du bureau du contact. |
parentFolderId | Chaîne | ID du dossier parent du contact. |
personalNotes | Chaîne | Notes de l’utilisateur sur le contact. |
phones | Collection phone | Numéros de téléphone associés au contact, par exemple, les numéros du téléphone résidentiel, du téléphone mobile et du téléphone professionnel. |
postalAddresses | collection physicalAddress | Adresses associées au contact, par exemple, l’adresse personnelle et l’adresse professionnelle. |
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. |
websites | Collection website | Sites Web associés au contact. |
weddingAnniversary | Date | L’anniversaire de mariage 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. |
Étant donné que la ressource de contact prend en charge les extensions, vous pouvez utiliser l’opération PATCH
pour ajouter, mettre à jour ou supprimer vos propres données spécifiques à l’application dans les propriétés personnalisées d’une extension dans un instance de contact existant.
Réponse
Si elle réussit, cette méthode renvoie un code de réponse et un 200 OK
objet contact mis à jour dans le corps de la réponse.
Exemple
Demande
L’exemple suivant met à jour l’adresse e-mail personnelle du contact spécifié.
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"
}
]
}
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
{
"@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"
}
}