SMsmartsheet
sheets

Copy sheet

Creates a copy of the specified sheet.

post/sheets/{sheetId}/copy

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: CREATE_SHEETS

Request body

destinationIdnumber required

The ID of the destination container.

destinationType'folder' | 'home' | 'workspace' nullable

Type of destination container.

The "home" enum has been Deprecated since March 25th 2025, and will be Sunset on or after November 15th 2026.

newNamestring

Name of the newly created object (when copying a dashboard, folder, or sheet).

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"
}

Changes

No recorded changes to this operation across all 16 revisions of this API.