Working with Excel Comments – Aspose.Cells Cloud API Guide

When creating an Excel workbook, users can add comments for various reasons. A common use is to explain a formula in a cell, especially when the file will be shared with others. Comments can also serve as reminders, notes for collaborators, or as a means of cross‑referencing with other workbooks. Once a comment has been added, Excel allows users to resize, reshape, and format the comment box to suit their preferred style. Mastering comment management helps users get the most out of this feature.

Prerequisites

• An active Aspose.Cells Cloud account.
• A valid access token obtained via OAuth 2.0.
• API version v3.0 (the endpoints used in this guide belong to this version).
• Optional: Aspose.Cells SDK for your preferred language to simplify request construction.

Version

The examples below target Aspose.Cells Cloud REST API v3.0. Future API releases may introduce additional parameters or modify response structures; always consult the latest API reference for up‑to‑date details.

Add a Comment

To add a comment, send a POST request to the following endpoint:

POST https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments
Authorization: Bearer {access_token}
Content-Type: application/json

Path parameters

Request body schema

Sample request body

{
  "CellName": "B2",
  "Comment": "Review needed",
  "Author": "John Doe"
}

Sample successful response (200 OK)

{
  "Code": 200,
  "Status": "OK",
  "Comment": {
    "CellName": "B2",
    "Author": "John Doe",
    "HtmlComment": "Review needed",
    "Note": "Review needed"
  }
}

Common error codes

Get Comments

Retrieve all comments from a worksheet:

GET https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments
Authorization: Bearer {access_token}

Path parameters

Sample response

{
  "Code": 200,
  "Status": "OK",
  "Comments": [
    {
      "CellName": "A1",
      "Author": "Alice",
      "HtmlComment": "Initial value",
      "Note": "Initial value"
    },
    {
      "CellName": "B2",
      "Author": "John Doe",
      "HtmlComment": "Review needed",
      "Note": "Review needed"
    }
  ]
}

Update a Comment

To modify an existing comment, send a PUT request. The comment is identified by its index in the worksheet’s comment collection (starting at 0).

PUT https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments/{commentIndex}
Authorization: Bearer {access_token}
Content-Type: application/json

Path parameters

Request body schema

Sample request body

{
  "Comment": "Updated note text",
  "Author": "John Doe"
}

The response follows the same structure as the Add a Comment response.

Delete a Comment

Remove a single comment by its index:

DELETE https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments/{commentIndex}
Authorization: Bearer {access_token}

Path parameters

A successful deletion returns:

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

Delete All Comments

To clear every comment from a worksheet:

DELETE https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments
Authorization: Bearer {access_token}

Path parameters

Error‑handling guidance

• 404 Not Found – Verify that the workbook ID, worksheet name, and comment index are correct.
• 400 Bad Request – Check JSON syntax and required fields (CellName, Comment).
• 429 Too Many Requests – Implement exponential back‑off and respect the Retry-After header.

Summary

• Excel comments are used to add a note or explain a formula in a cell.
• Excel provides users with the flexibility of editing, deleting, and showing or hiding comments on a worksheet.
• Users can also resize and move the comment box.

For more information on working with other spreadsheet elements, see the guide on working with cells.