Skip to content

profile-post-names.md

Latest commit

 

History

History
179 lines (138 loc) · 6.39 KB

profile-post-names.md

File metadata and controls

179 lines (138 loc) · 6.39 KB
title Create personName
description Use this API to create a new personName in a user's profile.
ms.localizationpriority medium
author kevinbellinger
ms.subservice people
doc_type apiPageType
ms.date 06/10/2024

Create personName

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

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

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

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

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
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. The 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 (for example: PhD.)
title String Honorifics used to prefix a users' name (for example: 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 example shows a request.

HTTP

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
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows 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
}