Skip to main content
Anchor to fileUpdate

fileUpdate

mutation

Requires write_files access scope or write_themes access scope. Also: Users must have edit files permissions.

Updates properties, content, and metadata associated with an existing file asset that has already been uploaded to Shopify.

Use the fileUpdate mutation to modify various aspects of files already stored in your store. Files can be updated individually or in batches.

The fileUpdate mutation supports updating multiple file properties:

  • Alt text: Update accessibility descriptions for images and other media.
  • File content: Replace image or generic file content while maintaining the same URL.
  • Filename: Modify file names (extension must match the original).
  • Product references: Add or remove associations between files and products. Removing file-product associations deletes the file from the product's media gallery and clears the image from any product variants that were using it.

The mutation handles different file types with specific capabilities:

  • Images: Update preview images, original source, filename, and alt text.
  • Generic files: Update original source, filename, and alt text.
  • Videos and 3D models: Update alt text and product references.
Note

Files must be in ready state before they can be updated. The mutation includes file locking to prevent conflicts during updates. You can't simultaneously update both originalSource and previewImageSource.

After updating files, you can use related mutations for additional file management:

  • fileCreate: Create new file assets from external URLs or staged uploads.
  • fileDelete: Remove files from your store when they are no longer needed.

Learn how to manage product media and file assets in your app.

Anchor to Arguments

Arguments

Anchor to filesfiles
•[FileUpdateInput!]!
required

List of files to be updated.

Was this section helpful?

Anchor to FileUpdatePayload returnsFileUpdatePayload returns

Anchor to filesfiles
•[File!]

The list of updated files.

Anchor to userErrorsuserErrors
•[FilesUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?