Skip to content

Latest commit

 

History

History
155 lines (125 loc) · 5.75 KB

profile-post-notes.md

File metadata and controls

155 lines (125 loc) · 5.75 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
Create notes
Create a new notes object.
kevinbellinger
medium
people
apiPageType

Create personAnnotation

Namespace: microsoft.graph

Create a new personAnnotation 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/notes
POST /users/{id | userPrincipalName}/profile/notes

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 personAnnotation object.

The following table shows the properties that are possible to set within a new personAnnotation object in a user's profile.

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.
detail itemBody Contains the detail of the note itself.
displayName String Contains a friendly name for the note.
inference inferenceData Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.

Response

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

Examples

HTTP

POST https://graph.microsoft.com/beta/me/profile/notes
Content-Type: application/json

{
  "detail": {
    "contentType": "text",
    "content": "I am originally from Australia, but grew up in Moscow, Russia."
  },
  "displayName": "About Me"
}

C#

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

CLI

[!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

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"
    }
  },
  "detail": {
    "contentType": "text",
    "content": "I am originally from Australia, but grew up in Moscow, Russia."
  },
  "displayName": "About Me"
}