Update Worksheet Cell Comment – Aspose.Cells Cloud API

This REST API updates a comment on a worksheet cell. Use this endpoint to update a worksheet comment in an Excel file.

Prerequisites:

A valid OAuth/JWT access token must be included in the Authorization header.
The workbook must be stored in a supported cloud storage location (specify folder and optionally storageName).

REST API

POST 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 Excel document.
sheetName	string	path	The name of the worksheet that contains the cell.
cellName	string	path	The address of the cell (e.g., A1).
comment	object	body	A Comment object that defines the comment to be added or updated.
folder	string	query	The folder where the document is stored.
storageName	string	query	The name of the storage service.

The OpenAPI Specification defines a publicly accessible programming interface and lets you 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 make a call to the Cloud API with cURL.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/worksheets/Sheet1/comments/a1" \
  -X POST \
  -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

{
  "Code": 200,
  "Status": "OK"
}

Possible response status codes:

Code	Description
200	Comment updated successfully.
400	Bad request – missing or invalid parameters.
401	Unauthorized – authentication failed.
404	Not found – workbook, worksheet, or comment does not exist.
500	Internal server error.

Notes / Tips:

Maximum comment length is 1024 characters.
Supported characters are UTF‑8; avoid control characters.

Cloud SDK Family

Using an SDK is the fastest way to develop with Aspose.Cells Cloud. An SDK handles low‑level details so you can focus on your project. 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:

Related Operations:

Add Worksheet Comment Delete a Worksheet Comment