Add Worksheet Comment

This REST API adds a comment to a specific worksheet cell.

REST API

PUT https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/comments/{cellName}

Request Parameters

Parameter Name	Type	Location	Description
name	string	path	The name of the workbook file.
sheetName	string	path	The name of the worksheet.
cellName	string	path	The address of the cell (e.g., A1).
comment	object	body	The Comment object that contains the comment data.
folder	string	query	The folder where the workbook is stored.
storageName	string	query	The name of the storage service.

All production calls must use HTTPS to protect the bearer token and ensure secure transmission.

The OpenAPI Specification defines a publicly accessible programming interface, allowing you to perform REST interactions directly from a web browser.

You can use the cURL command-line tool to access Aspose.Cells web services easily. The following example shows how to call the Cloud API with cURL.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/worksheets/Sheet1/comments/a1" \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>" \
  -d '{ "CellName": "a1", "Author": "test", "HtmlNote": "string", "Note": "this is a comment", "AutoSize": true, "IsVisible": true, "Width": 10, "Height": 10}'

Response

{
  "Comment": {
    "CellName": "A1",
    "Author": "test",
    "HtmlNote": "<Font Style=\"FONT-WEIGHT: bold;FONT-FAMILY: Tahoma;FONT-SIZE: 9pt;COLOR: #000000;TEXT-ALIGN: left;\">this is a comment</Font>",
    "Note": "this is a comment",
    "AutoSize": true,
    "IsVisible": true,
    "Width": 10,
    "Height": 10,
    "TextHorizontalAlignment": "Left",
    "TextOrientationType": "NoRotation",
    "TextVerticalAlignment": "Top",
    "link": {
      "Href": "/test.xlsx/worksheets/Sheet1/comments/a1",
      "Rel": "self",
      "Title": null,
      "Type": null
    }
  },
  "Code": 200,
  "Status": "OK"
}

Possible HTTP response codes

Code	Description
200	Comment added successfully.
400	Bad request – missing or invalid parameters.
401	Unauthorized – invalid or missing authentication token.
404	Not found – the specified workbook, worksheet, or cell does not exist.
500	Internal server error – an unexpected condition occurred on the server.

Sample error response (e.g., 400 Bad Request)

{
  "Error": {
    "Code": "InvalidParameter",
    "Message": "The 'cellName' parameter is missing or malformed."
  },
  "Code": 400,
  "Status": "Bad Request"
}

Cloud SDK Family

Using an SDK is the best way to speed up development. An SDK handles low‑level details so you can focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:

Get Worksheet Comment – Aspose.Cells Cloud API Documentation Update a Worksheet Cell Comment