CData Python Connector for Smartsheet

Build 25.0.9454

CopySheet

Duplicate an existing sheet and relocate it to a specified folder, home directory, or workspace.

Input

Name Type Required Description
SheetId String False The unique identifier of the source sheet to be copied. This is a required parameter for initiating the copy operation.
DestinationType String False Specifies the type of container where the sheet will be copied. Accepted values are 'folder' (for folders), 'home' (for personal space), or 'workspace' (for shared workspaces).
DestinationId String False The unique identifier of the destination container. This is required if 'DestinationType' is 'folder' or 'workspace' but must be null when 'DestinationType' is 'home'.
NewName String False The desired name for the newly created copy of the sheet. This attribute is applicable for copy operations only and is ignored for move operations.
Include String False A comma-separated list of additional sheet elements to include in the copy operation. Options include 'attachments' (file attachments), 'cellLinks' (cross-sheet references), 'data' (includes cell data and formatting), 'discussions' (comments), 'filters', 'forms', 'ruleRecipients' (notification recipients must include 'rules'), 'rules' (workflow rules), 'shares' (shared user access). Note that the Cell history cannot be copied.
Exclude String False Optional parameter. Use 'sheetHyperlinks' to exclude hyperlinks in the copied sheet.

Result Set Columns

Name Type Description
Success String Indicates whether the sheet copy operation completed successfully. Returns 'true' for success and 'false' for failure.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454