Upload Files

Upload documents and images or update the file with a new version.

Salesforce stores files uploaded to a record or group as a ContentDocument. Each file has a ContentVersion record that corresponds to a specific version of the file. Additionally, ContentDocumentLink holds the polymorphic relationships between a file and where it's shared, such as a users, groups, and records. For information about working with files, see ContentDocument in Object Reference for Salesforce and Lightning Platform.

User Interface API provides two ways to upload a file in a request.

Upload a New File
Upload a File Version

To prevent duplication of file uploads, such as in situations where the network connection is unstable, use Idempotency Record Writes (Beta).

Note

Upload a New File

This request uploads an image with the .csv file extension. It creates a new ContentDocument, ContentVersion, and ContentDocumentLink in one request. After the file is uploaded, you can view it in Files home.

Example POST Request

1POST /ui-api/records/content-documents/content-versions

1{
2  "description": "My test file",
3  "title": "CSV File"
4}

Example CURL Request

1curl -H "X-PrettyPrint: 1"
2-F 'json={"title":"CSV File", "description":"My test file"};type=application/json'
3-F 'fileData=@aa.csv;type=application/octet-stream'
4-X POST https://{instance-name}.salesforce.com/services/data/v57.0/ui-api/records/content-documents/content-versions
5-H 'Authorization: Bearer your_access_token_here'

Example Response

1{
2  "contentDocument" : {
3    "apiName" : "ContentDocument",
4    "childRelationships" : { },
5    "eTag" : "32e236323d9e6feea5412bb694a9b33d",
6    "fields" : {
7      "CreatedDate" : {
8        "displayValue" : "11/2/2022, 11:13 AM",
9        "value" : "2022-11-02T18:13:53.000Z"
10      },
11      "Description" : {
12        "displayValue" : null,
13        "value" : "My test file"
14      },
15      "Id" : {
16        "displayValue" : null,
17        "value" : "069RM0000008MbJYAU"
18      },
19      "LastModifiedById" : {
20        "displayValue" : null,
21        "value" : "005RM000002dpIzYAI"
22      },
23      "LastModifiedDate" : {
24        "displayValue" : "11/2/2022, 11:13 AM",
25        "value" : "2022-11-02T18:13:53.000Z"
26      },
27      "SystemModstamp" : {
28        "displayValue" : null,
29        "value" : "2022-11-02T18:13:54.000Z"
30      },
31      "Title" : {
32        "displayValue" : null,
33        "value" : "CSV File"
34      }
35    },
36    "id" : "069RM0000008MbJYAU",
37    "lastModifiedById" : "005RM000002dpIzYAI",
38    "lastModifiedDate" : "2022-11-02T18:13:53.000Z",
39    "recordTypeId" : null,
40    "recordTypeInfo" : null,
41    "systemModstamp" : "2022-11-02T18:13:54.000Z",
42    "weakEtag" : 1667412834000
43  },
44  "contentDocumentLinks" : [ {
45    "apiName" : "ContentDocumentLink",
46    "childRelationships" : { },
47    "eTag" : "a9e9ca5f7e2eb85af2aef5ed122350c2",
48    "fields" : {
49      "ContentDocumentId" : {
50        "displayValue" : null,
51        "value" : "069RM0000008MbJYAU"
52      },
53      "Id" : {
54        "displayValue" : null,
55        "value" : "06ARM00000095a72AA"
56      },
57      "LinkedEntityId" : {
58        "displayValue" : null,
59        "value" : "005RM000002dpIzYAI"
60      },
61      "ShareType" : {
62        "displayValue" : "Inferred",
63        "value" : "I"
64      },
65      "SystemModstamp" : {
66        "displayValue" : null,
67        "value" : "2022-11-02T18:13:54.000Z"
68      }
69    },
70    "id" : "06ARM00000095a72AA",
71    "lastModifiedById" : null,
72    "lastModifiedDate" : null,
73    "recordTypeId" : null,
74    "recordTypeInfo" : null,
75    "systemModstamp" : "2022-11-02T18:13:54.000Z",
76    "weakEtag" : 1667412834000
77  } ],
78  "contentVersion" : {
79    "apiName" : "ContentVersion",
80    "childRelationships" : { },
81    "eTag" : "0cbf5c6af463dbda0d0741eeda132d7a",
82    "fields" : {
83      "ContentSize" : {
84        "displayValue" : null,
85        "value" : "26224"
86      },
87      "CreatedDate" : {
88        "displayValue" : "11/2/2022, 11:13 AM",
89        "value" : "2022-11-02T18:13:53.000Z"
90      },
91      "Description" : {
92        "displayValue" : null,
93        "value" : "My test file"
94      },
95      "Id" : {
96        "displayValue" : null,
97        "value" : "068RM0000008SBhYAM"
98      },
99      "LastModifiedById" : {
100        "displayValue" : null,
101        "value" : "005RM000002dpIzYAI"
102      },
103      "LastModifiedDate" : {
104        "displayValue" : "11/2/2022, 11:13 AM",
105        "value" : "2022-11-02T18:13:53.000Z"
106      },
107      "SystemModstamp" : {
108        "displayValue" : null,
109        "value" : "2022-11-02T18:13:54.000Z"
110      },
111      "Title" : {
112        "displayValue" : null,
113        "value" : "CSV File"
114      },
115      "VersionDataUrl" : {
116        "displayValue" : null,
117        "value" : "https://{instance-name}.documentforce.com/sfc/servlet.shepherd/version/download/068RM0000008SBh"
118      }
119    },
120    "id" : "068RM0000008SBhYAM",
121    "lastModifiedById" : "005RM000002dpIzYAI",
122    "lastModifiedDate" : "2022-11-02T18:13:53.000Z",
123    "recordTypeId" : "012000000000000AAA",
124    "recordTypeInfo" : null,
125    "systemModstamp" : "2022-11-02T18:13:54.000Z",
126    "weakEtag" : 1667412834000
127  }

Upload a File Version

This request uploads a new version of an image file with a new file name. It creates a new ContentVersion, and updates the existing objects to reference the new ContentVersion.