generateFileUploadUrl( )

Generates an upload URL to allow external clients to upload a file to the Media Manager.

To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see Upload API (SDK | REST).

Notes:

  • When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready (SDK | REST).
  • Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, call Generate File Resumable Upload URL instead. With the resumable upload URL, any interruption in the upload process pauses the file upload, and resumes the file upload process after the interruption.
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 Bookings Services and Settings
Manage Media Manager
Manage Events
Manage Portfolio
Access Verticals by Automations
Set Up Automations
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
mimeTypestringRequired

File mime type.

optionsGenerateFileUploadUrlOptions

Options to use when generating a file's upload URL.

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

There are 5 errors with this status code.

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

Did this help?