Skip to content

workbookcomment-post-comments.md

Latest commit

 

History

History
231 lines (174 loc) · 7.27 KB

workbookcomment-post-comments.md

File metadata and controls

231 lines (174 loc) · 7.27 KB
title Create workbookComment
description Create a new workbookComment object.
ms.localizationpriority medium
author AmandaHan123
ms.subservice excel
doc_type apiPageType
ms.date 09/05/2025

Create workbookComment

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a new workbookComment object.

[!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/drive/items/{id}/workbook/comments
POST /me/drive/root:/{item-path}:/workbook/comments
POST /users/{id}/drive/items/{id}/workbook/comments
POST /users/{id}/drive/root:/{id}:/workbook/comments

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 a workbookComment object.

Response

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

Examples

Example 1: Create a comment of a plain contentType

The following example shows how to create a comment of a plain contentType.

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/me/drive/items/01CYZLFJGUJ7JHBSZDFZFL25KSZGQTVAUN/workbook/comments
Content-Type: application/json

{
  "cellAddress": "Sheet1!A1",
  "content": "This is my comment.",
  "contentType": "plain"
}

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]

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

{
  "content": "This is my comment.",
  "contentType": "plain",
  "id": "{97A21473-8339-4BF0-BCB6-F55E4909FFB8}",
  "cellAddress": "Sheet1!A1",
  "richContent": "",
  "mentions": []
}

Example 2: Create a comment of a mention contentType

The following example shows how to create a comment of a mention contentType.

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/me/drive/items/01CYZLFJGUJ7JHBSZDFZFL25KSZGQTVAUN/workbook/comments
Content-Type: application/json

{
  "cellAddress": "Sheet1!A1",
  "richContent": "<at id=\"0\">Kate Kristensen</at> - This is my comment.",
  "mentions": [
    {
      "id": 0,
      "name": "Kate Kristensen",
      "email": "kakri@contoso.com"
    }
  ],
  "contentType": "mention"
}

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]

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

{
  "content": "@Kate Kristensen - This is my comment.",
  "contentType": "mention",
  "id": "{97A21473-8339-4BF0-BCB6-F55E4909FFB8}",
  "richContent": "<at id=\"0\">Kate Kristensen</at> - This is my comment.",
  "mentions": [
    {
      "id": 0,
      "name": "Kate Kristensen",
      "email": "kakri@contoso.com"
    }
  ],
  "cellAddress": "Sheet1!A1"
}