v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

comments

Edit a comment

Updates the text of a comment. NOTE: Only the user that created the comment is permitted to update it.

put/sheets/{sheetId}/comments/{commentId}

Headers

Content-Typestring

Required for POST and PUT requests. Defines the structure for the request body.

Request body

textstring

Comment body.

Response

SUCCESS

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3

'0' Success
'3' Partial Success of Bulk Operation

versionnumber nullable

New version of the Sheet. Applicable only for operations which update sheet data.

Example response

{
  "message": "SUCCESS",
  "result": {
    "attachments": [
      {
        "mimeType": "PNG",
        "createdBy": {
          "email": "jane.doe@smartsheet.com",
          "name": "Jane Doe"
        }
      }
    ],
    "createdBy": {
      "email": "jane.doe@smartsheet.com",
      "name": "Jane Doe"
    }
  }
}