Skip to main content
Version: Current

Rename Sheet

Description​

Renames a sheet within a Google Spreadsheet.

The sheet remains in the same position and retains all existing data, formatting, formulas, and properties.


Common Capabilities​

Process Data Support​

info

This activity supports dynamic configuration using variables from the Process Data drawer.

You can bind values from Agent Data, Workflow Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.

Learn more → Using Process Data


Design-Time Configuration​

Display Text​

A user-defined name for the activity, displayed on the workflow canvas to help identify its purpose.

Connection Name​

The configured Google Sheets connection used to access Google Sheets resources.

Spreadsheet​

The spreadsheet containing the sheet to rename.

Current Sheet Name​

The name of the sheet to rename.

New Sheet Name​

The new name to assign to the sheet.

info

For details about selecting spreadsheets and sheets, see Google Sheets Data Selection.


Wait All Incoming​

Execution Control

Controls how this activity behaves when multiple incoming execution paths converge.

Determines whether the activity executes when:

  • Any incoming path completes, or
  • All relevant incoming paths complete before execution

Learn more → Execution Control


On Error​

Error Handling Strategy

Defines how the workflow behaves if this activity encounters a runtime error.

Supported strategies include:

  • Fault
  • Continue
  • Suspend
  • Retry

Learn more → Error Handling


Output​

Result​

A Boolean value indicating whether the rename operation completed successfully.

ValueMeaning
TrueThe sheet was successfully renamed.
FalseThe rename operation was unsuccessful.

Remarks​

  • The authenticated Google account must have permission to modify the spreadsheet.
  • Renaming a sheet changes only the sheet name; the sheet contents and properties remain unchanged.
  • The new sheet name must be unique within the spreadsheet.
  • Existing formulas, references, and integrations that refer to the sheet by name may be affected by the rename.
  • Google Sheets naming restrictions apply to the new sheet name.