PATCH /automation/v1/fileTransfers/{FileTransferId}/

Update an existing File Transfer Activity definition.

NAME	TYPE	DESCRIPTION
ID	guid	Unique identifier of the file transfer activity.
Name	string	Name of the file transfer activity.
Description	string	Description of the file transfer activity.
CustomerKey	string	Client-specified unique identifier of the file transfer activity.
FileSpec	string	Name of the file that will be used in the File Transfer Activity.
IsEncrypted	bool	Indicates whether the File Transfer Activity will perform encryption/decryption.
IsCompressed	bool	Indicates whether the File Transfer Activity will perform compression/decompression.
MaxFileAge	number	Maximum age of a file in hours that can be processed by the File Transfer Activity. If the file is older than this number of hours, an Invalid File Age error will occur. Set to 0 to disable this guardrail.
MaxFileAgeScheduleOffset	number	Maximum delay in hours that can be tolerated for processing the file. If the activity takes longer than this timespan to process the file, an Invalid File Age error will occur. Set to 0 to disable this guardrail.
MaxImportFrequency	number	Minimum number of hours required between runs of this File Transfer Activity. If an instance of the File Transfer Activity attempts to run sooner than the specified number of hours, that instance will fail. Set to 0 to disable this guardrail.
FileTransferLocationID	guid	Unique identifier of the file transfer location that holds the file. This can be retrieved from the /automations/v1/ftpLocations route.
IsUpload	bool	Valid values are true/false. This indicates whether data is coming in or out. For activities that transfer files, true causes the file to be uploaded to the file transfer location, and false causes the file to be downloaded from the file transfer location. If IsEncrypted is set, then true will trigger encryption, and false will trigger decryption. If IsCompressed is set, then true will trigger compression, and false will trigger decompression.
IsPgp	bool	Set this value to true to use asymmetric encryption. False will cause the File Transfer Activity to run with symmetric encryption.
IsFileSpecLocalized	bool	Determines if the time should be localized when using file naming patterns like %%Hour%% in the FileSpec property.
PublicKeyManagementId	number	When using an encryption key loaded in Public Key Management, use this ID to specify the key to use.
CreatedDate	date	Timestamp when the file transfer activity was created. Set to null for creating a new activity.
ModifiedDate	date	Timestamp when the file transfer activity was last modified. Set to null for creating a new activity.

STATUS	NAME	TYPE	DESCRIPTION
200			OK
	ID	guid	Unique identifier of the file transfer activity.
	Name	string	Name of the file transfer activity.
	CustomerKey	string	Client-specified unique identifier of the file transfer activity.
	FileSpec	string	Name of the file that will be used in the File Transfer Activity.
	IsEncrypted	bool	Indicates whether the File Transfer Activity will perform encryption/decryption.
	IsCompressed	bool	Indicates whether the File Transfer Activity will perform compression/decompression.
	MaxFileAge	number	Maximum age of a file in hours that can be processed by the File Transfer Activity. If the file is older than this number of hours, an Invalid File Age error will occur. Set to 0 to disable this guardrail.
	MaxFileAgeScheduleOffset	number	Maximum delay in hours that can be tolerated for processing the file. If the activity takes longer than this timespan to process the file, an Invalid File Age error will occur. Set to 0 to disable this guardrail.
	MaxImportFrequency	number	Minimum number of hours required between runs of this File Transfer Activity. If an instance of the File Transfer Activity attempts to run sooner than the specified number of hours, that instance will fail. Set to 0 to disable this guardrail.
	FileTransferLocationId	guid	Unique identifier of the file transfer location that holds the file. This can be retrieved from the /automations/v1/ftpLocations route.
	IsUpload	bool	Valid values are true/false. This indicates whether data is coming in or out. For activities that transfer files, true causes the file to be uploaded to the file transfer location, and false causes the file to be downloaded from the file transfer location. If IsEncrypted is set, then true will trigger encryption, and false will trigger decryption. If IsCompressed is set, then true will trigger compression, and false will trigger decompression.
	IsPgp	bool	Set this value to true to use asymmetric encryption. False will cause the File Transfer Activity to run with symmetric encryption.
	PublicKeyManagementId	number	When using an encryption key loaded in Public Key Management, use this ID to specify the key to use.
	IsFileSpecLocalized	bool	Determines if the time should be localized when using file naming patterns like %%Hour%% in the FileSpec property.
	CreatedDate	date	Timestamp when the file transfer activity was created.
	ModifiedDate	date	Timestamp when the file transfer activity was last modified.
400			Bad Request
	Message	string	The value specified for the following field is not valid: 'publicKeyManagementId'. Note: If you encounter this error, please ensure the publicKeyManagementId corresponds to a valid key in Public Key Management._
400			Bad Request
	Message	string	The value specified for the following field is not valid: 'fileTransferLocationId'. Note: If you encounter this error, please ensure the fileTransferLocationId corresponds to a valid key in File Transfer Locations._
403			Unauthorized
	Message	string	Insufficient privileges
500			Error
	ErrorCode	number	10000