Create personName

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Use this API to create a new personName object in a user's profile.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) User.Read, User.ReadWrite, User.ReadBasic.All, User.Read.All, User.ReadWrite.All
Delegated (personal Microsoft account) User.Read, User.ReadWrite, User.ReadBasic.All, User.Read.All, User.ReadWrite.All
Application User.ReadBasic.All, User.Read.All, User.ReadWrite.All

HTTP request

POST /me/profile/names
POST /users/{id | userPrincipalName}/profile/names

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the personName object.

The following table shows the properties that are possible to set when you create a personName object.

Property Type Description
allowedAudiences String The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me, family, contacts, groupMembers, organization, federatedOrganizations, everyone, unknownFutureValue.
displayName String Provides an ordered rendering of firstName and lastName depending on the locale of the user or their device.
first String First name of the user.
id String Identifier used for individually addressing the entity. Inherited from entity
inference inferenceData Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet.
initials String Initials of the user.
languageTag String Contains the name for the language (en-US, no-NB, en-AU) following IETF BCP47 format.
last String Last name of the user.
maiden String Maiden name of the user.
middle String Middle name of the user.
nickname String Nickname of the user.
pronunciation yomiPersonName Guidance on how to pronounce the users name.
suffix String Designators used after the users name (eg: PhD.)
title String Honorifics used to prefix a users name (eg: Dr, Sir, Madam, Mrs.)

Response

If successful, this method returns 201, Created response code and a new personName object in the response body.

Examples

Request

The following is an example of the request.

POST https://graph.microsoft.com/beta/me/profile/names
Content-type: application/json

{
  "displayName": "Innocenty Popov",
  "first": "Innocenty",
  "initials": "IP",
  "last": "Popov",
  "languageTag": "en-US",
  "maiden": null
}

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
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"
    }
  },
  "displayName": "Innocenty Popov",
  "first": "Innocenty",
  "initials": "IP",
  "last": "Popov",
  "languageTag": "en-US",
  "maiden": null,
  "middle": null,
  "nickname": null,
  "suffix": null,
  "title": null,
  "pronunciation": null
}