File
The input fields that are required to update a file object.
Anchor to FieldsFields
- alt (String)
- filename (String)
- id (ID)
- originalSource (String)
- parentDirectoryId (ID)
- parentDirectoryPath (String)
- previewImageSource (String)
- referencesToAdd ([ID!])
- referencesToRemove ([ID!])
- •String
The alt text description of the file for screen readers and accessibility.
- Anchor to filenamefilename•String
The name of the file including its extension.
- •ID
The ID of the file to be updated.
- Anchor to originalSourceoriginal•String
Source The source from which to update a media image or generic file. This can be an external URL or a staged upload URL.
- Anchor to parentDirectoryIdparent•ID
Directory Id The ID of the parent directory to move the file into. To move a file to the root, use parentDirectoryPath: '/' instead. Cannot be used together with parentDirectoryPath.
- Anchor to parentDirectoryPathparent•String
Directory Path The full parent directory path to move the file into (e.g. 'public/assets/images'). Files can only be moved under the default 'public' directory; use 'public' to move to its top most level. Cannot be used together with parentDirectoryId.
- Anchor to previewImageSourcepreview•String
Image Source The source from which to update the media preview image. May be an external URL or a staged upload URL.
- Anchor to referencesToAddreferences•[ID!]
To Add The IDs of the references to add to the file. Currently only accepts product IDs.
- Anchor to referencesToRemovereferences•[ID!]
To Remove The IDs of the references to remove from the file. Currently only accepts product IDs.