Delete a Worksheet Comment

A comment is a text note attached to a specific cell in an Excel worksheet. This REST API deletes such a comment from a worksheet cell.

REST API

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

Request Parameters

The endpoint accepts the following parameters:

Parameter Name	Type	Location	Required	Description
name	string	path	Yes	The name of the Excel document.
sheetName	string	path	Yes	The name of the worksheet.
cellName	string	path	Yes	The address of the cell (e.g., `A1`).
folder	string	query	No	The folder that contains the document.
storageName	string	query	No	The name of the storage service.

Request Example

Request

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/worksheets/Sheet1/comments/A1" \
  -X DELETE \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

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

Error Responses

HTTP Code	Description	Example Response
400	Bad request – missing or malformed parameters.	`{ "Code": 400, "Message": "Invalid parameters." }`
401	Unauthorized – invalid or missing token.	`{ "Code": 401, "Message": "Authentication required." }`
404	Not found – the file, worksheet, or comment does not exist.	`{ "Code": 404, "Message": "Resource not found." }`
500	Internal server error – unexpected condition on the server.	`{ "Code": 500, "Message": "Server error." }`

For a complete list of status codes, refer to the Error Responses section above.

The OpenAPI Specification for DeleteWorksheetComment provides a machine‑readable description of this endpoint.

Cloud SDK Family

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

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

Update a Worksheet Cell Comment Clear Worksheet Comments