Create a request.txt File

A batch is represented by a zip file, which contains a CSV, XML, or JSON file called request.txt that contains references to the binary attachments and the binary attachments themselves. This differs from CSV, XML, or JSON batch files that don’t include binary attachments. These batch files don’t need a zip or a request.txt file.

The request.txt file is contained in the base directory (at the root) of the zip file. The binary attachments can also be in the base directory or they can be organized in optional subdirectories.

If you create a zip file on OS X by right-clicking a folder and choosing "Compress" - it won't work. The result is an extra folder level inside the zip file. You can use zip to create it properly and unzip -l to check it.

Note

The request.txt file is a manifest file for the attachments in the zip file and contains the data for each record that references a binary file.

The batch data file is named request.txt, whether you’re working with CSV, XML, or JSON data.

Note

For the Attachment object, the notation for these fields is particularly important:

The Name field is the file name of the binary attachment. The easiest way to get a unique name for each attachment in your batch is to use the relative path from the base directory to the binary attachment. For example, attachment1.gif or subdir/attachment2.doc.
The Body is the relative path to the binary attachment, preceded with a # symbol. For example, #attachment1.gif or #subdir/attachment2.doc.
The ParentId field identifies the parent record, such as an account or a case, for the attachment.

The batch file can also include other optional Attachment fields, such as Description. For more information, see Attachment.

Sample CSV request.txt File

This sample CSV file includes two Attachment records. The first record references an attachment1.gif binary file in the base directory of the zip file. The second record references an attachment2.doc binary file in the subdir subdirectory of the zip file. In this example, the ParentId field indicates that both attachments are associated with Account parent records. The Account Id variable should be replaced with the Id of the associated parent account.

Name,ParentId,Body
attachment1.gif,Account Id,#attachment1.gif
subdir/attachment2.doc,Account Id,#subdir/attachment2.doc

Sample XML request.txt File

This sample XML file includes the same two records as the previous CSV sample file.

<?xml version="1.0" encoding="UTF-8"?>
<sObjects
   xmlns="http://www.force.com/2009/06/asyncapi/dataload"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <sObject>
    <Name>attachment1.gif</Name>
    <ParentId>Account Id</ParentId>
    <Body>#attachment1.gif</Body>
  </sObject>
  <sObject>
    <Name>subdir/attachment2.doc</Name>
    <ParentId>Account Id</ParentId>
    <Body>#subdir/attachment2.doc</Body>
  </sObject>
</sObjects>

Sample JSON request.txt File

This sample JSON file includes the same two records as the previous examples.

[
  {
    "Name" : "attachment1.gif",
    "ParentId" : "Account Id",
    "Body" : "#attachment1.gif"
  },
  {
    "Name" : "subdir/attachment2.doc",
    "ParentId" : "Account Id",
    "Body" : "#subdir/attachment2.doc"
  }
]

Bulk API 2.0 and Bulk API Developer Guide

No Results

Create a request.txt File

Sample CSV request.txt File

Sample XML request.txt File

Sample JSON request.txt File