generateFileResumableUploadUrl( )

Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager.

The generateFileResumableUploadUrl() function returns a Promise that resolves to an upload URL, token, and protocol.

When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. The resumable upload URL is also helpful when network connection is poor.

To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see the Resumable Upload API article.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Manage Media Manager
Manage Restaurants - all permissions
Learn more about permission scopes.
Method Declaration
Method Parameters

File mime type.


Options to use when generating a resumable upload URL.

Return Type:Promise<GenerateFileResumableUploadUrlResponse>
Was this helpful?