Set-FilesBundle
Update Share Link.
Syntax
Id (Default)
InputObject
Description
Update Share Link.
The command accepts bundles from the pipeline as -InputObject, and uses each one's Id 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.
File parameters take a FilesAttachment: a local file from Get-Item, such as (Get-Item ./logo.png), or one New-FilesAttachment makes from a file, bytes or a stream. The file goes in the same request as the other parameters, whose values are sent exactly as they would be without it; a local file is opened, and a stream read, only when the command goes ahead with the change: never under -WhatIf or when a confirmation is declined. A stream is borrowed: the command leaves it open.
Examples
Example 1: Update Share Link
Writes the bundle as Files.com returns it.
Example 2: Act on bundles from the pipeline
Takes the bundle from the pipeline and uses its Id and connection.
Example 3: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Id
Bundle ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Paths
A list of paths to include in this bundle.
- Type:
System.String[] - Parameter sets:
Id,InputObject
-Password
Password for this bundle. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
Id,InputObject
-BypassesSiteExpirationRules
If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-FormFieldSetId
Id of Form Field Set to use with this bundle
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-ClickwrapId
ID of the clickwrap to use with this bundle.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-Code
Bundle code. This code forms the end part of the Public URL.
- Type:
System.String - Parameter sets:
Id,InputObject
-CreateSnapshot
If true, create a snapshot of this bundle's contents.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-Description
Public description
- Type:
System.String - Parameter sets:
Id,InputObject
-DontSeparateSubmissionsByFolder
Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-ExpiresAt
Explicit Bundle expiration date/time. If not set, the site-wide expiration setting may apply. 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:
Id,InputObject
-FinalizeSnapshot
If true, finalize the snapshot of this bundle's contents. Note that create_snapshot must also be true.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-InboxId
ID of the associated inbox, if available.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-MaxUses
Maximum number of times bundle can be accessed
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-GroupId
Owning group ID. If set, members of this group can view, edit, and share this Share Link.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-InternalName
Internal name for identifying this Share Link.
- Type:
System.String - Parameter sets:
Id,InputObject
-Note
Bundle internal note
- Type:
System.String - Parameter sets:
Id,InputObject
-PathTemplate
Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.
- Type:
System.String - Parameter sets:
Id,InputObject
-PathTemplateTimeZone
Timezone to use when rendering timestamps in path templates.
- Type:
System.String - Parameter sets:
Id,InputObject
-Permissions
Permissions that apply to Folders in this Share Link.
- Type:
System.String - Parameter sets:
Id,InputObject
-RequireRegistration
Show a registration page that captures the downloader's name and email address?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-RequireShareRecipient
Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-SendOneTimePasswordToRecipientAtRegistration
If true, require_share_recipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-SendEmailReceiptToUploader
Send delivery receipt to the uploader. Note: For writable share only
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-SkipCompany
BundleRegistrations can be saved without providing company?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-StartAccessOnDate
Date when share will start to be accessible. If nil access granted right after create. 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:
Id,InputObject
-SkipEmail
BundleRegistrations can be saved without providing email?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-SkipName
BundleRegistrations can be saved without providing name?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-UserId
The owning user id. Only site admins can set this.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-WatermarkAttachmentDelete
If true, will delete the file stored in watermark_attachment
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-WatermarkAttachmentFile
Preview watermark image applied to all bundle items. Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
Id,InputObject
-WatermarkValue
Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
Id,InputObject
-WorkspaceId
Workspace ID. 0 means the default workspace.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-InputObject
The bundle to act on, such as one written by another command of the module, from the pipeline. The command uses its Id and the connection that fetched it.
- Type:
FilesCom.PowerShell.Models.Bundle - 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
$ConfirmPreferenceofHigh, the command runs without asking;-Confirmmakes 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.Bundle: a bundle from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.Bundle: the bundle 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.