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 bookmarks

• Set copyBookmarks to all to copy every saved view (formerly "bookmarks") 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 bookmarks transfers to the user initiating the copy operation.