Skip to main content

Rename Sheet

Renames a sheet within a Google Spreadsheet.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Spreadsheet Id - The ID of the Google Spreadsheet containing the sheet to rename.
  • Sheet Name - The current name of the sheet to be renamed.
  • New Sheet Name - The new name to assign to the sheet.

Options​

No additional options available for this node.

Output​

No output variables for this node.

How It Works​

The Rename Sheet node changes the name of a specific sheet within a Google Spreadsheet. When executed, the node:

  1. Validates all input parameters
  2. Connects to the Google Spreadsheet using the provided ID
  3. Locates the sheet with the specified current name
  4. Gets the sheet ID for the sheet to be renamed
  5. Constructs an update sheet properties request with the new name
  6. Sends the rename request to the Google Sheets API
  7. Returns any errors encountered during the process

Requirements​

  • A valid Google Spreadsheet ID
  • A valid current sheet name that exists in the spreadsheet
  • A valid new sheet name
  • Proper Google Sheets API authentication and permissions

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid Spreadsheet Id
  • Empty or invalid Sheet Name
  • Empty or invalid New Sheet Name
  • Sheet with the specified name does not exist
  • Google Sheets API authentication or permission errors
  • Network or connectivity issues with Google Sheets API

Usage Notes​

  • The Spreadsheet Id can be obtained from the URL of your Google Spreadsheet or from the Open Spreadsheet node
  • The Sheet Name must exactly match an existing sheet in the spreadsheet
  • The New Sheet Name must be unique within the spreadsheet
  • This operation modifies the spreadsheet structure, so use with caution
  • Ensure your Google account has proper permissions to modify the target spreadsheet