Rename File
Audience:
Business UsersSkill Prerequisites:
Tokens
Renames a file in its current folder. You provide the new name without the extension, and the file keeps its original extension.
Typical Use Cases
- Give an uploaded file a meaningful name, for example
Invoice-[InvoiceNumber] - Rename a copied template after Copy File
- Add a date or status to a file name, for example
Report-2026-09-25
Don't use it to
- Change a file's extension or type. The original extension is always kept.
- Move a file to another folder. Use Copy File and Delete File instead.
- Rename a folder. Use Rename Folder instead.
Related Actions
| Action Name | Description |
|---|---|
| Copy File | Copies a file, which you can then rename. |
| Rename Folder | Renames a folder. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| File | The file to rename. It can be a file ID (77), a path relative to the portal root (Images/Cars/Ford.jpg), a path that includes the portal folder (Portals/0/Images/Cars/Ford.jpg), a LinkClick URL, or the full physical path. | Yes | empty string | Yes |
| Rename to | The new file name, without a path and without the extension, for example Invoice. | Yes | empty string | Yes |
| Ignore Errors | When checked, errors such as a missing file are written to the site's event log and the remaining actions keep running. When unchecked, an error stops execution. | No | Unchecked | No |
How the extension is handled
The action compares the extension in Rename to with the file's extension, and adds the file's extension if they don't match exactly. The comparison is case-sensitive.
| Original file | Rename to | Result |
|---|---|---|
scan.pdf | Invoice-1001 | Invoice-1001.pdf |
scan.pdf | Invoice-1001.pdf | Invoice-1001.pdf |
scan.pdf | Invoice-1001.docx | Invoice-1001.docx.pdf |
scan.pdf | Invoice-1001.PDF | Invoice-1001.PDF.pdf |
Considerations
- The action fails if a file with the new name already exists in the same folder.
- The file's URL changes. Links that use the file ID keep working.
- The action doesn't produce output tokens. The file ID doesn't change, so you can keep using the ID you already have.
Examples
tip
To understand how to use the below examples, please see Running Examples.
1. Rename an uploaded file using form data
This action renames the file uploaded in the Invoice field to Invoice-<InvoiceNumber>, keeping its extension.
{
"Title": "Rename File",
"ActionType": "RenameFile",
"Description": "Give the uploaded invoice a meaningful name",
"Condition": null,
"Parameters": {
"File": "[Invoice:FileId]",
"NewName": "Invoice-[InvoiceNumber]",
"IgnoreErrors": false
}
}
Revised 09/25/2026