Users Files, General

When you upload a file to the Files home, it is private and available only to the file owner.

To upload a file, send it in a multipart/form-data request. You can include the description and title of the file in the multipart/form-data request as a JSON or XML request body. You can also send the information as request parameters. For information about how to create the multipart/form-data message, see Uploading Binary Files.

Resource

Available since version

36.0

In versions 24.0–35.0, use /chatter/users/userId/files and /connect/communities/communityId/chatter/users/userId/files, which require Chatter.

Requires Chatter

No

HTTP methods

GET, POST, or HEAD

Request body for POST

To upload a file, provide the binary file in a multipart/form-data body part where name="fileData". See Uploading Binary Files.

Root XML tag

<fileInput>

JSON

Properties

Name	Type	Description	Required or Optional	Available Version
content​ModifiedDate	String	File-specific last modified date that can be used to set a client-side modified date. Specify the date in ISO 8601 format.	Optional	32.0
desc	String	Description of the file to be uploaded.	Optional	24.0
includeExternal​FilePermissions​Info	Boolean	Specifies whether to include permission information, such as whether the file is shared and what are the available permission types, for external files. This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId.	Optional	35.0
isInMyFileSync	Boolean	true if the file is synced with Salesforce Files Sync; false otherwise. Salesforce Files Sync was retired on May 25, 2018. Note	Optional	31.0
isMajorVersion	Boolean	true if the file is a major version; false if the file is a minor version. Major versions can’t be replaced.	Optional	31.0
parentFolderId	String	ID of the containing folder.	Optional	31.0
repository​FileId	String	ID of the external file. This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId. If you specify repositoryFileId, don’t specify repositoryFileUri.	Optional	32.0
repository​FileUri	String	URI of the external file, such as https://drive.google.com/file/d/​0B7a_ei8brT1TMy1CQ0o5NmZQNEE/view. This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId. If you specifyrepositoryFileUri, don’t specify repositoryFileId.	Optional	39.0
repositoryId	String	ID of the external data source. This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId.	Required if repositoryFileId is specified. Otherwise, Optional.	32.0
reuseReference	Boolean	Specifies whether to reuse the latest version of a reference you own to an external file rather than creating a duplicate reference. This property can be used with POST requests to /connect/files/users/userId, but not with POST requests to /connect/files/fileId.	Optional	36.0
sharingOption	String	Sharing option of the file. Values are: Allowed—Resharing of the file is allowed. Restricted—Resharing of the file is restricted.	Optional	35.0
sharingPrivacy	String	Sharing privacy of a file. Values are: None—File is visible to anyone with record access. PrivateOnRecords—File is private on records.	Optional	41.0
title	String	Title of the file.	Optional	24.0

Request parameters for POST

Name	Type	Description	Required or Optional	Available version
content​ModifiedDate	String	File-specific last modified date that can be used to set a client-side modified date. Specify the date in ISO 8601 format.	Optional	32.0
desc	String	Description of the file	Optional	24.0
includeExternal​FilePermissions​Info	Boolean	Specifies whether to include permission information, such as whether the file is shared and what are the available permission types, for external files.	Optional	35.0
isDataSync	Boolean	An automated client generates the request.	Optional	31.0
isInMyFileSync	Boolean	true if the file is synced with Salesforce Files Sync; false otherwise. Salesforce Files Sync was retired on May 25, 2018. Note	Optional	31.0
isMajorVersion	Boolean	true if the file is a major version; false if the file is a minor version. Major versions can’t be replaced. The default value is false.	Optional	31.0
repository​FileId	String	ID of the external file.	Optional	32.0
repository​FileUri	String	URI of the external file, such as https://drive.google.com/file/d/​0B7a_ei8brT1TMy1CQ0o5NmZQNEE/view.	Optional	39.0
repositoryId	String	ID of the external data source.	Required if repositoryFileId is specified. Otherwise, Optional.	32.0
reuseReference	Boolean	Specifies whether to reuse the latest version of a reference you own to an external file rather than creating a duplicate reference.	Optional	36.0
sharingOption	String	Sharing option of the file. Values are: Allowed—Resharing of the file is allowed. Restricted—Resharing of the file is restricted.	Optional	35.0
sharingPrivacy	String	Sharing privacy of a file. Values are: None—File is visible to anyone with record access. PrivateOnRecords—File is private on records.	Optional	41.0
title	String	Title of the file	Optional	24.0

Request parameters for GET

Parameter Name	Type	Description	Available Since
page	Integer	An integer specifying a page of items. The default value is 0, which returns the first page.	24.0
pageSize	Integer	Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.	24.0
q	String	A query string to filter the results. The string must contain at least two characters, not including wildcards. For information about wildcards, see Wildcards.	27.0

Response body for GET

File Summary Page

Response body for POST

File Summary

Example POST request

This example creates a file and uploads it to Salesforce. The example shows the body parts in a multipart/form-data request. The first body part is a File Input request body. The second is the content of the file. For more information, see Uploading Binary Files.