---
schema_version: "1"
id: d08f15d5f119b227ea0c49d99ec28415f18530065b85f10cf9ce1eeef6b3c7fe
title: FileTransferActivity
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/marketing-cloud/guides/mc-apis/filetransferactivity.md
canonical_url: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/filetransferactivity.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 116250faee19678278781e904fc40941db282b147409b7eb82713f06f025b5a6
products:
  - Marketing Cloud Engagement APIs and Programmatic Languages
  - Marketing Cloud
---
# FileTransferActivity

An object that represents an instance of a file transfer activity within an account. Use the perform method on an existing file transfer activity. To start a FileTransferActivity using the perform method, you need the `Interactions | Activities | File Transfer | Start` permission.

## Properties

| Name                  | Data Type                                      | Description                                                                                                                               |
| --------------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `Client`              | [ClientID](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/clientid.md) object                 | Specifies the account ownership and context of an object.                                                                                 |
| `CorrelationID`       | String                                         | Identifies correlation of objects across several requests.                                                                                |
| `CreatedDate`         | DateTime                                       | The date and time when the object was created.                                                                                            |
| `CustomerKey`         | String                                         | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
| `Description`         | String                                         | Describes and provides information regarding the object.                                                                                  |
| `ID`                  | Int                                            | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID.                                                |
| `InteractionObjectID` | String                                         | Returns associated ID for activities within the asynchronous process of the overall conversation or program.                              |
| `Keyword`             | String                                         | Not used.                                                                                                                                 |
| `ModifiedDate`        | DateTime                                       | The date and time when the object was last modified.                                                                                      |
| `Name`                | String                                         | Name of the object or property.                                                                                                           |
| `ObjectID`            | String                                         | System-controlled, read-only text string identifier for object.                                                                           |
| `ObjectState`         | String                                         | Not used.                                                                                                                                 |
| `Owner`               | [Owner](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/owner.md) object                       | Describes account ownership of subscriber in an on-your-behalf account.                                                                   |
| `PartnerKey`          | String                                         | Unique identifier provided by partner for an object. This property is accessible only via API.                                            |
| `PartnerProperties`   | Array of [APIProperty](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/apiproperty.md) objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.                   |

## PartnerProperties Values

The `PartnerProperties` property for this object accepts the value and data types listed in this table.

| Value                    | Data Type                                  |
| ------------------------ | ------------------------------------------ |
| FileTransferLocationKey  | string                                     |
| FileTransferLocationID   | GUID                                       |
| PublicKeyManagementKey   | string                                     |
| PublicKeyManagementId    | int                                        |
| FileTransferActivityID   | GUID                                       |
| ClientID                 | int                                        |
| OwnerID                  | int                                        |
| Name                     | string                                     |
| Description              | string                                     |
| CustomerKey              | string                                     |
| FileSpec                 | string                                     |
| IsActive                 | bool                                       |
| IsEncrypted              | bool                                       |
| IsCompressed             | bool                                       |
| IsSigned                 | bool                                       |
| Retries                  | int                                        |
| RetryInterval            | int                                        |
| MaxFileAge               | int                                        |
| MaxFileAgeScheduleOffset | int                                        |
| MaxImportFrequency       | int                                        |
| CreatedBy                | int                                        |
| CreatedDate              | datetime                                   |
| ModifiedBy               | int                                        |
| ModifiedDate             | datetime                                   |
| IsSequential             | bool                                       |
| IsSuccessfulWithoutFile  | bool                                       |
| IsUpload                 | bool                                       |
| IsPgp                    | bool                                       |
| MaxAgeUnit               | FileTransferActivityMaxAgeUnit enumeration |

Currently, 0-Hour is the only valid enumeration for `MaxAgeUnit`. The `PartnerProperties` property for this object in a Perform call accepts the value and data types listed in this table.

| Value              | Data Type |
| ------------------ | --------- |
| Type               | string    |
| SourceResourceSpec | string    |
| IsCompressed       | bool      |
| OutputFilename     | string    |
| IsEncrypted        | bool      |
| Encrypt            | string    |
| EncryptionKey      | string    |

## Related Items

- [Supported Operations for Objects and Methods](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/supported_operations_for_objects_and_methods.md)
- [Perform a File Transfer Activity](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/performing_a_file_transfer_activity_via_the_soap_api.md)