Skip to main content

InitiateDataRoomBulkDownloadInput

Input for initiating a bulk download request.

input InitiateDataRoomBulkDownloadInput {
  dataRoomId: ID!
  bulkDownloadName: String!
  documentIds: [ID!]
  folderIds: [ID!]
}

Fields​

InitiateDataRoomBulkDownloadInput.dataRoomId ● ID! non-null scalar​

The data room ID that contains the documents and folders to download. This must be a valid data room that the authenticated user has access to.

InitiateDataRoomBulkDownloadInput.bulkDownloadName ● String! non-null scalar​

Display name for the bulk download request. This value is also used as the base name of the downloaded ZIP file. Example: if bulkDownloadName is "Project Docs", the downloaded file name will be "Project Docs.zip".

Note: the server may sanitize this value for filename safety (e.g., remove/replace characters not allowed in file names) and may adjust it to avoid collisions.

InitiateDataRoomBulkDownloadInput.documentIds ● [ID!] list scalar​

Specific document IDs to include.

InitiateDataRoomBulkDownloadInput.folderIds ● [ID!] list scalar​

Folder IDs whose documents should be included.

Member Of​

initiateDataRoomBulkDownload mutation