Set-FilesFile

Update File/Folder Metadata.

Syntax

Path (Default)

Set-FilesFile [-Path] <System.String> [-CustomMetadata <System.Collections.IDictionary>] [-ProvidedMtime <System.DateTimeOffset>] [-PriorityColor <System.String>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Set-FilesFile [-CustomMetadata <System.Collections.IDictionary>] [-ProvidedMtime <System.DateTimeOffset>] [-PriorityColor <System.String>] -InputObject <FilesCom.PowerShell.Models.RemoteFile> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Update File/Folder Metadata.

The command accepts files from the pipeline as -InputObject, and uses each one's Path and the connection that fetched it.

When given -InputObject, the command updates that object with the values Files.com returns and writes it.

The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.

Examples

Example 1: Update File/Folder Metadata

Set-FilesFile -Path 'path' -CustomMetadata @{ department = 'finance' } -PriorityColor 'red'

Writes the file as Files.com returns it.

Example 2: Act on files from the pipeline

Get-FilesFile -Path 'path' | Set-FilesFile -CustomMetadata @{ department = 'finance' } -PriorityColor 'red'

Takes the file from the pipeline and uses its Path and connection.

Example 3: Preview the change

Set-FilesFile -Path 'path' -CustomMetadata @{ department = 'finance' } -PriorityColor 'red' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Path

Path to operate on.

  • Type: System.String
  • Parameter sets: Path (required, position 0)

-CustomMetadata

Custom metadata map of keys and values. Limited to 32 keys, 256 characters per key and 1024 characters per value. Give a hashtable or PSCustomObject; keys keep their case and values their types.

  • Type: System.Collections.IDictionary
  • Parameter sets: Path, InputObject

-ProvidedMtime

Modified time of file. Give a DateTime from Get-Date, a DateTimeOffset, or ISO 8601 text with an offset such as 2026-01-31T14:00:00Z.

  • Type: System.DateTimeOffset
  • Parameter sets: Path, InputObject

-PriorityColor

Priority/Bookmark color of file.

  • Type: System.String
  • Parameter sets: Path, InputObject

-InputObject

The file to act on, such as one written by another command of the module, from the pipeline. The command uses its Path and the connection that fetched it.

  • Type: FilesCom.PowerShell.Models.RemoteFile
  • Parameter sets: InputObject (required)

-Connection

The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.

  • Type: FilesCom.PowerShell.FilesConnection
  • Parameter sets: (All)

-WorkspaceScope

Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.

  • Type: System.Int64
  • Parameter sets: (All)

-NoWorkspaceScope

Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.

  • Type: System.Management.Automation.SwitchParameter
  • Parameter sets: (All)

-Confirm

Prompts you for confirmation before running the cmdlet.

  • Type: System.Management.Automation.SwitchParameter
  • Confirm impact: Medium. At the default $ConfirmPreference of High, the command runs without asking; -Confirm makes it ask before each change.

-WhatIf

Shows what the cmdlet would change without sending anything to Files.com.

  • Type: System.Management.Automation.SwitchParameter

Common Parameters

This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.

Inputs

  • FilesCom.PowerShell.Models.RemoteFile: a file from another command of the module, as -InputObject.

Outputs

  • FilesCom.PowerShell.Models.RemoteFile: the remote file as Files.com returned it.

Notes

Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.