Action: Copy Worksheet

Google Sheets Operation

The Copy Worksheet action duplicates an entire worksheet within the same or another spreadsheet.

Example User Story

I want to copy a worksheet within a Google Sheet so that I can create a duplicate with a new name.

Fields

Field Name	Field Type	Required
spreadsheetId	String	Yes
sheetId	Integer	Yes
newSheetName	String	Yes

Related Connections

Google Sheets

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "copy-worksheet",
  "state": "inDev",
  "meta": {
    "short": "Copy Worksheet",
    "description": "Copies a worksheet within a Google Sheet to a new worksheet."
  },
  "input": [
    {
      "name": "spreadsheetId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The spreadsheet to copy the sheet within."
      }
    },
    {
      "name": "sheetId",
      "type": "Integer",
      "required": true,
      "meta": {
        "description": "The ID of the worksheet to copy."
      }
    },
    {
      "name": "newSheetName",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The name of the new worksheet."
      }
    }
  ],
  "output": [
    {
      "name": "newSheetId",
      "type": "Integer",
      "selector": [
        "body",
        "sheetId"
      ],
      "meta": {
        "description": "The ID of the newly created worksheet."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": {
          "value": "/{{spreadsheetId}}:batchUpdate"
        },
        "headers": {
          "Content-Type": {
            "value": "application/json"
          }
        },
        "bodyTemplate": {
          "value": "{\"requests\": [{\"duplicateSheet\": {\"sourceSheetId\": {{sheetId}}, \"newSheetName\": \"{{newSheetName}}\"}}]}",
          "placeholders": [
            {
              "name": "sheetId",
              "type": "Integer",
              "description": "The ID of the worksheet to copy.",
              "required": true,
              "default": ""
            },
            {
              "name": "newSheetName",
              "type": "String",
              "description": "The name of the new worksheet.",
              "required": true,
              "default": ""
            }
          ]
        }
      }
    }
  ]
}