generateFileUploadUrl( )

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

The generateFileUploadUrl() function returns a Promise that resolves to an upload URL.

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

Note: Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use generateFileResumableUploadUrl() 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.

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
Copy
Method Parameters
mimeTypestringRequired

File mime type.

optionsGenerateFileUploadUrlOptions

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

Returns
Return Type:Promise<GenerateFileUploadUrlResponse>
Was this helpful?
Yes
No