Skip to main content

initiateDataRoomBulkDownload

Submits a request to package selected documents and/or folders into a downloadable ZIP archive.

Integration workflow​

  1. (Optional) Fetch documentIds and folderIds using dataRoomDocumentIndex.
  2. Call initiateDataRoomBulkDownload with the selected IDs.
  3. Poll dataRoomBulkDownload until status is DONE, using the returned bulkDownload.id.
  4. Fetch downloadUrl and download the archive.

Selection rules​

  • You must provide at least one item in documentIds or folderIds. If both lists are empty (or omitted), the request is rejected as invalid.
  • To download **all** documents the current user can access, include the **root folder** ID for the Data Room in folderIds.

Archive contents​

The generated ZIP includes a JSON mapping file at: Required Configuration Files/DocumentIdToArchivePath.json

It contains a mapping of documentId -> document path/name inside the archive.

It may also include bulk download error items (for example, document IDs that could not be included).

initiateDataRoomBulkDownload(
  input: InitiateDataRoomBulkDownloadInput!
): InitiateDataRoomBulkDownloadPayload!

Arguments​

initiateDataRoomBulkDownload.input ● InitiateDataRoomBulkDownloadInput! non-null input​

The bulk download name, document IDs and folder IDs to include in the archive.

Type​

InitiateDataRoomBulkDownloadPayload object​

Payload wrapper for create bulk download mutation results.