Update itememail

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Actualizar las propiedades de un objeto itemEmail en el perfil de un usuario.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) User.ReadWrite AgentIdUser.ReadWrite.All, AgentIdUser.ReadWrite.IdentityParentedBy, User.ReadWrite.All
Delegado (cuenta personal de Microsoft) User.ReadWrite No disponible.
Aplicación No admitida. No admitida.

Solicitud HTTP

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

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json. Obligatorio.

Cuerpo de solicitud

En el cuerpo de la solicitud, proporcione los valores de los campos relevantes que deben actualizarse. Las propiedades existentes que no están incluidas en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad. Para obtener el mejor rendimiento, no incluya valores existentes que no hayan cambiado.

En la tabla siguiente se muestran las propiedades que es posible actualizar dentro de un objeto itemEmail existente en el perfil de un usuario.

Propiedad Tipo Descripción
address Cadena La propia dirección de correo electrónico.
allowedAudiences Cadena Las audiencias que pueden ver los valores contenidos dentro de la entidad. Heredado de itemFacet. Los valores posibles son: me, family, contacts, groupMembersorganization, federatedOrganizations, , everyone, , . unknownFutureValue
displayName Cadena El nombre o etiqueta que un usuario tiene asociado a una dirección de correo electrónico determinada.
de inferencia inferenciaData Contiene detalles de inferencia si la entidad se deduce mediante la aplicación de creación o modificación. Heredado de itemFacet.
source personDataSource Dónde se originaron los valores si se sincronizaron desde otro servicio. Heredado de itemFacet.
type emailType El tipo de dirección de correo electrónico. Los valores posibles son: unknown, work, personal, main, other.

Respuesta

Si se realiza correctamente, este método devuelve un código de 200 OK respuesta y un objeto itemEmail actualizado en el cuerpo de la respuesta.

Ejemplos

Solicitud

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

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

Respuesta

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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"
}