Skip to main content

initiateDataRoomDocumentDownload

Initiates the asynchronous download process for a document. This mutation creates a download request and triggers the system to prepare the file (e.g., perform permission checks, apply watermarking, encryption, etc.).

The document is not immediately available. Clients must poll the status of the download using the dataRoomDocumentDownload(id: ID!) query until the DocumentTransferStatus becomes either:

COMPLETED — indicating the downloadPresignedUrl is ready for use. FAILED — indicating the request could not be fulfilled (see failureReason for details).

initiateDataRoomDocumentDownload(
  input: InitiateDataRoomDocumentDownloadInput!
): InitiateDataRoomDocumentDownloadPayload

Arguments​

initiateDataRoomDocumentDownload.input ● InitiateDataRoomDocumentDownloadInput! non-null input​

The input containing the document ID to download.

Type​

InitiateDataRoomDocumentDownloadPayload object​

Represents the response payload returned after initiating a document download from the Data Room. It contains a reference to the DataRoomDocumentDownload object, which can be monitored for progress and result.