Rename Folder

Audience: Business Users

Skill Prerequisites: Tokens

Renames a folder. The folder stays in the same parent folder, and its files and subfolders go with it.

Typical Use Cases

• Rename a folder when the record it belongs to is renamed, for example a customer or a project
• Add a status marker to a folder name, for example Apollo - Closed

Don't use it to

• Move a folder to a different parent folder. Use Move Folder instead.
• Rename a file. Use Rename File instead.

Related Actions

Action Name	Description
Move Folder	Moves a folder into another folder.
Rename File	Renames a single file.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Folder	The folder to rename, as a path relative to Portals/<PortalID>/ (for example Projects/Apollo/). Folder IDs aren't supported by this action.	Yes	empty string	Yes
Rename to	The new folder name, for example Apollo - Closed. Enter a name only, not a path. The action fails if the value contains / or \.	Yes	empty string	Yes
Ignore Errors	When checked, errors such as a missing folder or an invalid name are written to the site's event log and the remaining actions keep running. When unchecked, an error stops execution.	No	Unchecked	No

Considerations

• URLs change. The path of every file inside the folder changes, so any saved URL or path that points to those files stops working. Links that use the file ID keep working.
• The action fails if a folder with the new name already exists in the same parent folder.
• The action doesn't produce output tokens. If you need the new path, build it from the parent path and the new name.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Rename a customer folder

This action renames Clients/<OldName>/ to the value of the NewName form field. If the folder doesn't exist, the error is logged and the other actions keep running.

{
    "Title": "Rename Folder",
    "ActionType": "RenameFolder",
    "Description": "Rename the customer's folder",
    "Condition": null,
    "Parameters": {
        "Folder": "Clients/[OldName]/",
        "NewName": "[NewName]",
        "IgnoreErrors": true
    }
}

Revised 09/25/2026