initiateBulkDownload( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Initiates a bulk download process.

The process creates a .zip file containing the requested files. The .zip file is available for download using the downloadUrl in the bulkDownload response. The downloadUrl is available for 24 hours after the process begins. Downloads creation is limited per user up to 10 at once.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Receipts
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
bulkDownloadBulkDownloadRequired

Bulk download to initiate.

Returns
Return Type:Promise<BulkDownload>
Errors
400Invalid Argument

There is 1 error with this status code.

403Permission Denied

There is 1 error with this status code.

404Not Found

There is 1 error with this status code.

428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?