Skip to navigation
Sigma REST APIWorkbooks{workbookId}

Duplicate a workbook

View as Markdown

This endpoint lets you duplicate an existing workbook. The workbook copy can be placed in a different folder from the original workbook, potentially with a different name and description. This is useful for creating workbook templates or backups.

Usage notes

  • The workbookId in the URL specifies the original workbook to be copied. Retrieve the workbookId by calling the /v2/workbooks endpoint.

  • The destinationFolderId in the request body specifies where to place the new workbook.

    • To use the “My Documents” folder for a specific user as the destination folder, call the /v2/members/{memberId} endpoint and use the homeFolderId included in the response.
    • Retrieve the folderId of all folders by calling the /v2/files endpoint and reviewing the id field in the response for files with a type of folder.

Usage scenarios

  • Reuse: Use an existing workbook as a baseline for a “one-off” purpose instead of a template.
  • Template creation: Create a copy of a workbook to serve as a template for future projects.
  • Backup: Make a backup of a workbook before making significant changes. Version tagging is also a useful way to accomplish this.

Best practices

  • Always verify that the destination folder has the correct permissions set to avoid access issues.
  • When using as a template, ensure that all data connections are correctly configured to prevent data leaks or errors.

Copying saved views

  • Set copyBookmarks to all to copy every saved view (formerly called a bookmark) applied to the source workbook. This is available to admins only.
  • Set copyBookmarks to accessible to copy personal saved views and those shared with the user initiating the operation.
  • Ownership of all copied saved views transfers to the user initiating the copy operation.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.

Request

Body parameters for copying a workbook.
destinationFolderIdstringRequired
ID of the folder in which to place the copied workbook.
namestringRequired
Name for the copied workbook as it appears in Sigma.
descriptionstringOptional
A description for the new workbook.
copyBookmarksenumOptional

If set to all (available to admins only), every saved view (formerly called a bookmark) applied to the workbook is copied. If set to accessible, only personal saved views and those shared with the user initiating the operation are copied. Ownership of all saved views in the duplicate workbook transfers to the user initiating the operation. If not set, saved views are not copied.

Allowed values:

Response

The response body.
workbookIdstring
Unique identifier of the workbook.
workbookUrlIdstring
namestring
urlstring
pathstring
latestVersiondouble
The most recently published document version of the workbook.
ownerIdstring
createdBystring
The identifier of the user who created this object.
updatedBystring
The identifier of the user or process that last updated this object.
createdAtdatetime
When the object was created.
updatedAtdatetime
When the object was last updated.
isArchivedbooleanOptional
tagslist of objectsOptional
descriptionstringOptional
taggedSourceUrlIdstringOptional

For a workbook deployed to a tenant organization by a deployment policy with a version tag, the urlId of the original source workbook in the parent organization. Only present when includeTaggedSourceUrlId=true is included in the request.