Skip to main content

initiateDataRoomDocumentUpload

Initiates the single-part upload process for a document. This mutation sets up an upload session and returns an upload object, along with a pre-signed URL that can be used to upload the file directly to storage.

After the file is uploaded, it enters a processing phase (e.g., virus scanning, indexing). The document becomes available in the Data Room only after this phase completes.

To track the status of the upload, clients should poll the dataRoomDocumentUpload(id: ID!) query until the upload reaches either:

COMPLETED – the document is processed and available. FAILED – the upload or processing encountered an error.

initiateDataRoomDocumentUpload(
  input: InitiateDataRoomDocumentUploadInput!
): InitiateDataRoomDocumentUploadPayload

Arguments​

initiateDataRoomDocumentUpload.input ● InitiateDataRoomDocumentUploadInput! non-null input​

Input containing the Data Room ID, optional folder ID, and file name.

Type​

InitiateDataRoomDocumentUploadPayload object​

Returned when starting a single-part upload for a document in the Data Room. This response provides both the upload session metadata and a secure pre-signed URL that the client can use to upload the document directly to storage.

This marks the beginning of the upload pipeline. After the file is uploaded, the system continues with internal processing (e.g., virus scan, indexing) before the document becomes fully available.