Mettre à jour itememail

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 .

Mettre à jour les propriétés d’un objet itemEmail dans le profil d’un utilisateur.

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

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) User.ReadWrite AgentIdUser.ReadWrite.All, AgentIdUser.ReadWrite.IdentityParentedBy, User.ReadWrite.All
Déléguée (compte Microsoft personnel) User.ReadWrite Non disponible.
Application Non prise en charge. Non prise en charge.

Requête HTTP

PATCH /me/profile/emails/{id}
PATCH /users/{id | userPrincipalName}/profile/emails/{id}

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
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 conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas été modifiées.

Le tableau suivant indique les propriétés qui peuvent être mises à jour dans un objet itemEmail existant dans le profil d’un utilisateur.

Propriété Type Description
address String L’adresse e-mail elle-même.
allowedAudiences String Les publics qui sont en mesure de voir les valeurs contenues dans l’entité. Hérité de itemFacet. Les valeurs possibles sont : me, , contactsfamily, groupMembers, organizationfederatedOrganizationseveryoneunknownFutureValue.
displayName String Nom ou étiquette qu’un utilisateur a associé à une adresse e-mail particulière.
inférence inferenceData Contient des détails d’inférence si l’entité est déduite par l’application de création ou de modification. Hérité de itemFacet.
source personDataSource L’origine des valeurs si elles sont synchronisées à partir d’un autre service. Hérité de itemFacet.
type emailType Type d’adresse e-mail. Les valeurs possibles sont : unknown, work, personal, main, other.

Réponse

En cas de succès, cette méthode renvoie un 200 OK code de réponse et un objet itemEmail mis à jour dans le corps de la réponse.

Exemples

Demande

PATCH https://graph.microsoft.com/beta/users/{userId}/profile/emails/{id}
Content-Type: application/json

{
  "displayName": "Business Email",
  "type": "work"
}

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": "0fb4c1e3-c1e3-0fb4-e3c1-b40fe3c1b40f",
  "allowedAudiences": "organization",
  "inference": null,
  "createdDateTime": "2020-07-06T06:34:12.2294868Z",
  "createdBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "lastModifiedDateTime": "2020-07-06T06:34:12.2294868Z",
  "lastModifiedBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "address": "Innocenty.Popov@adventureworks.com",
  "displayName": "Business Email",
  "type": "work"
}