> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # Duplicate a tagged workbook POST https://api.sigmacomputing.com/v2/workbooks/{workbookId}/tag/{versionTag}/copy Content-Type: application/json This endpoint lets you duplicate a tagged workbook, creating a new workbook from the tagged version. 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 and version tag in the URL specify the tagged version of the workbook to duplicate. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. For the **versionTag**, you can specify either the tag name or ID. Retrieve the version tag name or ID by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) 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}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response. * Retrieve the **folderId** of all folders by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. ### Best practices * Always verify that the destination folder has the correct permissions set to avoid access issues. Reference: https://help.sigmacomputing.com/reference/copy-tagged-workbook ## Authentication - OAuth2 — send the obtained token as `Authorization: Bearer ` ## Servers - `https://api.sigmacomputing.com` (Server for GCP (US) hosted organizations, default) - `https://api.sa.gcp.sigmacomputing.com` (Server for GCP (KSA) hosted organizations) - `https://aws-api.sigmacomputing.com` (Server for AWS US (West) hosted organizations) - `https://api.us-a.aws.sigmacomputing.com` (Server for AWS US (East) hosted organizations) - `https://api.ca.aws.sigmacomputing.com` (Server for AWS Canada hosted organizations) - `https://api.eu.aws.sigmacomputing.com` (Server for AWS Europe hosted organizations) - `https://api.au.aws.sigmacomputing.com` (Server for AWS Australia and APAC hosted organizations) - `https://api.uk.aws.sigmacomputing.com` (Server for AWS UK hosted organizations) - `https://api.us.azure.sigmacomputing.com` (Server for Azure US hosted organizations) - `https://api.eu.azure.sigmacomputing.com` (Server for Azure Europe hosted organizations) - `https://api.ca.azure.sigmacomputing.com` (Server for Azure Canada hosted organizations) - `https://api.uk.azure.sigmacomputing.com` (Server for Azure United Kingdom hosted organizations) - `https://api.au.azure.sigmacomputing.com` (Server for Azure Australia hosted organizations) ## Request ### Path parameters - `workbookId` (string, required) - `versionTag` (string, required) ### Body (application/json) - `destinationFolderId` (string, required) — ID of the folder in which to place the copied workbook. - `name` (string, required) — Name for the copied workbook as it appears in Sigma. - `description` (string, optional) — A description for the new workbook. - `copyBookmarks` (enum, optional) — If set to `all` (available to admins only), every saved view (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: `all`, `accessible` ## Response ### 200 The response body. - `workbookId` (string, required) — Unique identifier of the workbook. - `workbookUrlId` (string, required) - `name` (string, required) - `url` (string, required) - `path` (string, required) - `latestVersion` (double, required) - `ownerId` (string, required) - `createdBy` (string, required) — The identifier of the user who created this object. - `updatedBy` (string, required) — The identifier of the user or process that last updated this object. - `createdAt` (datetime, required) — When the object was created. - `updatedAt` (datetime, required) — When the object was last updated. - `isArchived` (boolean, optional) - `tags` (list of object, optional) - `versionTagId` (string, required) — Unique identifier of the tag. - `name` (string, required) - `sourceWorkbookVersion` (double, required) - `taggedWorkbookId` (string, required) — Unique identifier of the tagged workbook. - `workbookTaggedAt` (datetime, required) - `description` (string, optional) - `taggedSourceUrlId` (string, optional) — 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. ## Examples **Request** ```json { "destinationFolderId": "string", "name": "string" } ``` **Response** ```json { "workbookId": "string", "workbookUrlId": "string", "name": "string", "url": "string", "path": "string", "latestVersion": 1.1, "ownerId": "string", "createdBy": "string", "updatedBy": "string", "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-01-15T09:30:00Z", "isArchived": true, "tags": [ { "versionTagId": "string", "name": "string", "sourceWorkbookVersion": 1.1, "taggedWorkbookId": "string", "workbookTaggedAt": "2024-01-15T09:30:00Z" } ], "description": "string", "taggedSourceUrlId": "string" } ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/workbooks/workbookId/tag/versionTag/copy" payload = { "destinationFolderId": "string", "name": "string" } headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/workbooks/workbookId/tag/versionTag/copy'; const options = { method: 'POST', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{"destinationFolderId":"string","name":"string"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/workbooks/workbookId/tag/versionTag/copy" payload := strings.NewReader("{\n \"destinationFolderId\": \"string\",\n \"name\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/workbooks/workbookId/tag/versionTag/copy") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{\n \"destinationFolderId\": \"string\",\n \"name\": \"string\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.sigmacomputing.com/v2/workbooks/workbookId/tag/versionTag/copy") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{\n \"destinationFolderId\": \"string\",\n \"name\": \"string\"\n}") .asString(); ``` ```php request('POST', 'https://api.sigmacomputing.com/v2/workbooks/workbookId/tag/versionTag/copy', [ 'body' => '{ "destinationFolderId": "string", "name": "string" }', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/workbooks/workbookId/tag/versionTag/copy"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"destinationFolderId\": \"string\",\n \"name\": \"string\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [ "destinationFolderId": "string", "name": "string" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/workbooks/workbookId/tag/versionTag/copy")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```