Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
attachments

Attach file or URL to comment

Attaches a file to the comment. The URL can be any of the following:

  • Normal URL (attachmentType "LINK")
  • Box.com URL (attachmentType "BOX_COM")
  • Dropbox URL (attachmentType "DROPBOX")
  • Egnyte URL (attachmentType "EGNYTE")
  • Evernote URL (attachmentType "EVERNOTE")
  • Google Drive URL (attachmentType "GOOGLE_DRIVE")
  • OneDrive URL (attachmentType "ONEDRIVE")

Important: Smartsheet Gov allows only the following attachment types:

  • BOX_COM
  • FILE
  • GOOGLE_DRIVE
  • LINK
  • ONEDRIVE

Important: The file size limit is 30mb.

This operation can be performed using a simple upload or a multipart upload.

Note: Posting a file attachment is resource-intensive and is limited to 30 requests per minute per API token. For details, see Rate limiting.

post/sheets/{sheetId}/comments/{commentId}/attachments

Headers

Content-Typestring

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

Request body

attachmentSubType'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET'

Attachment sub type.

Note: "FOLDER" type is for EGNYTE values--the rest are GOOGLE_DRIVE values.

attachmentType'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO'

Attachment type.

Note: "DROPBOX", "EGNYTE", and "EVERNOTE" aren't supported for Smartsheet.gov accounts.

descriptionstring
namestring
urlstring

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": {
    "mimeType": "PNG",
    "createdBy": {
      "email": "jane.doe@smartsheet.com",
      "name": "Jane Doe"
    }
  }
}