UpdateHotFolderInput

Type: Input

Fields

Name	Type	Default	Description
active	Boolean		Whether the hot folder is currently active
completedFolder	String		The name of the folder where completed files are moved
connectionUri	String		A connection string that specifies how to connect to the folder. The format of the string depends on how the
folder is accessible - for example an SMB share, an FTP server, or a local file system.

This connection string must match the operating mode of the folder, for example, if the mode is set to SMB, the connection string must be in the format of an SMB URI.

This value is stored encrypted in the database.

Examples:

• SMB: smb://username:password@server/share
• FTP: ftp://username:password@server/path
• Local: file:///path/to/folder | | errorFolder | String | | The name of the folder where failed files are moved | | functionId | ID | | | | handle | String | | A unique, script-friendly name for the hot folder | | mode | FolderOperatingMode | | The operating mode to connect to the hot folder | | networkId | ID | | | | processingFolder | String | | The name of the folder where files are moved during processing |