SharePoint - Rename Item
What it does
Rename a SharePoint file or folder without changing its parent location.
For files, provide the complete filename including its extension. The action changes the name, not the parent folder.
When to use it
- Apply a final filename after approval or signature.
- Rename a folder or document based on workflow data.
Apply a final filename after approval or signature.
Requirements
- A connected Microsoft 365 connection for this HighLevel Location.
- The Drive ID and Item ID of the item to rename.
- The complete new name; include the file extension when renaming a file.
Inputs
| Input | Type | Required | Description | Example value |
|---|---|---|---|---|
Document Library (Drive ID) | string | Yes | Microsoft Graph Drive ID for the SharePoint document library. The Drive ID identifies the library itself and can be reused across workflow actions. | b!exampleDriveId123 |
Item ID | string | Yes | Microsoft Graph DriveItem ID of the SharePoint file or folder. Usually map this from a previous action such as Get Item By Path, Search Items, or List Folder Items. | example-item-id |
New Name | string | Yes | New file or folder name, including the extension for a file. | Signed Contract.pdf |
Example values
- Document Library (Drive ID)
b!exampleDriveId123- Item ID
example-item-id- New Name
Signed Contract.pdf
Example workflow
- HighLevel workflow trigger
The business event that starts the workflow.
- SharePoint - Rename Item
Run the SharePoint operation with the approved Drive ID and action-specific inputs.
- Use the confirmed result
Map only the documented outputs required by the next workflow step.
A common pattern is: Get Item By Path → Rename Item → map the returned Item Name or Web URL into a later step.
Outputs
| Output | Type | Description | Example value | Use in later steps |
|---|---|---|---|---|
Success | boolean | Confirms that the action completed successfully. | true | Use as a completion checkpoint before relying on other outputs. |
Item ID | string | Microsoft Graph DriveItem ID of the resulting file or folder. | example-item-id | Map into Get Item, Move Item, Rename Item, Delete Item, or other ID-based steps. |
Item Name | string | Current name of the file or folder. | Renamed Document.pdf | Use for confirmation, messages, or later naming logic. |
Web URL | string | SharePoint web link for the resulting file or folder. | https://example.invalid/Renamed%20Document.pdf | Use when a later step or staff member needs the SharePoint link. |
Item Type | string | Normalized item type such as file or folder. | file | Use to distinguish file and folder results. |
How to use outputs in later HighLevel steps
Success: Use as a completion checkpoint before relying on other outputs.Item ID: Map into Get Item, Move Item, Rename Item, Delete Item, or other ID-based steps.Item Name: Use for confirmation, messages, or later naming logic.Web URL: Use when a later step or staff member needs the SharePoint link.Item Type: Use to distinguish file and folder results.
Use Item Name to confirm the final name and Web URL when a later step needs the updated SharePoint link.
Permissions required
- Microsoft Graph application permission Sites.Selected on the customer-owned Entra app.
- The SharePoint site containing the document library must grant the app at least write access for this operation.
- The action does not require tenant-wide SharePoint access merely for discovery or name matching.
Common errors
Authentication unavailable / 401- This HighLevel Location does not have a usable Microsoft connection. Verify the Location connection before changing SharePoint permissions.
403- The Entra app lacks access to the selected SharePoint site or the granted role is too narrow for the operation. Verify Sites.Selected consent and the site's write grant.
404- The Drive ID, folder path, or Item ID does not resolve in the connected tenant and approved site. Recheck the administrator's Drive ID map and the exact path or Item ID.
409- A destination name or state conflicts with an existing SharePoint item. Inspect the destination and choose the intended duplicate/conflict behavior before retrying.
429- Microsoft Graph throttled the request. Retry later and avoid high-volume loops without bounds.
Related actions
Product/action version
- Product version
- Pre-launch technical release · 2026-10-04
- Action version
- 1.1
- Implementation reference
- Integration commit 8440a0f · src/modules/workflows/actions/sharepoint-rename-item.json · code/sharepoint_rename_item.1.1.js