Anchor to section titled 'undefined'file
file
mutation
Unstable
Requires write access scope or write access scope.
Updates an existing file asset that was uploaded to Shopify.
Anchor to section titled 'Arguments'
Arguments
List of files to be updated.
Was this section helpful?
Anchor to section titled 'FileUpdatePayload returns'
FileUpdatePayload returns
The list of updated files.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: fileUpdate
Query Reference for MUTATION: fileUpdate
"mutation fileUpdate($files: [FileUpdateInput!]!) {\n fileUpdate(files: $files) {\n files {\n # File fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: fileUpdate
"{\n \"files\": [\n {\n \"alt\": \"<your-alt>\",\n \"filename\": \"<your-filename>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"originalSource\": \"<your-originalSource>\",\n \"previewImageSource\": \"<your-previewImageSource>\",\n \"referencesToAdd\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"referencesToRemove\": [\n \"gid://shopify/<objectName>/10079785100\"\n ]\n }\n ]\n}"Schema Reference for MUTATION: fileUpdate
"input FileUpdateInput {\n alt: String\n filename: String\n id: ID!\n originalSource: String\n previewImageSource: String\n referencesToAdd: [ID!]\n referencesToRemove: [ID!]\n}\n"Display Examples for MUTATION: fileUpdate
[
{
"example": {
"type_name": "fileupdate",
"title": "Update a file",
"description": "Update a file's alt text and return its ID and new alt text",
"query_string": "mutation FileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n userErrors {\n code\n field\n message\n }\n files {\n alt\n }\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/GenericFile/1072273203",
"alt": "new alt text"
}
},
"response": {
"data": {
"fileUpdate": {
"userErrors": [],
"files": [
{
"alt": "new alt text"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/file_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation FileUpdate($input: [FileUpdateInput!]!) { fileUpdate(files: $input) { userErrors { code field message } files { alt } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1072273203\",\n \"alt\": \"new alt text\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation FileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n userErrors {\n code\n field\n message\n }\n files {\n alt\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1072273203\",\n \"alt\": \"new alt text\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation FileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n userErrors {\n code\n field\n message\n }\n files {\n alt\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1072273203\",\n \"alt\": \"new alt text\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation FileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n userErrors {\n code\n field\n message\n }\n files {\n alt\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1072273203\",\n \"alt\": \"new alt text\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation FileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n userErrors {\n code\n field\n message\n }\n files {\n alt\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/GenericFile/1072273203\",\n \"alt\" => \"new alt text\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
},
{
"example": {
"type_name": "fileupdate",
"title": "Update a generic file",
"description": "Updating the contents of a file while preserving the same URL",
"query_string": "mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on GenericFile {\n id\n url\n }\n }\n userErrors {\n message\n }\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/GenericFile/1072273204",
"originalSource": "https://example.com/manual.pdf"
}
},
"response": {
"data": {
"fileUpdate": {
"files": [
{
"id": "gid://shopify/GenericFile/1072273204",
"url": "https://cdn.shopify.com/s/files/1/2637/1970/files/original_name.pdf?v=1726103340"
}
],
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/file_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fileUpdate($input: [FileUpdateInput!]!) { fileUpdate(files: $input) { files { ... on GenericFile { id url } } userErrors { message } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1072273204\",\n \"originalSource\": \"https://example.com/manual.pdf\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on GenericFile {\n id\n url\n }\n }\n userErrors {\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1072273204\",\n \"originalSource\": \"https://example.com/manual.pdf\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on GenericFile {\n id\n url\n }\n }\n userErrors {\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1072273204\",\n \"originalSource\": \"https://example.com/manual.pdf\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on GenericFile {\n id\n url\n }\n }\n userErrors {\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1072273204\",\n \"originalSource\": \"https://example.com/manual.pdf\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on GenericFile {\n id\n url\n }\n }\n userErrors {\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/GenericFile/1072273204\",\n \"originalSource\" => \"https://example.com/manual.pdf\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
},
{
"example": {
"type_name": "fileupdate",
"title": "Update an image",
"description": "Updating the contents of an image while preserving the same URL",
"query_string": "mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on MediaImage {\n id\n image {\n url\n }\n }\n }\n userErrors {\n message\n }\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/MediaImage/1072273202",
"originalSource": "https://example.com/image.jpg"
}
},
"response": {
"data": {
"fileUpdate": {
"files": [
{
"id": "gid://shopify/MediaImage/1072273202",
"image": null
}
],
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/file_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fileUpdate($input: [FileUpdateInput!]!) { fileUpdate(files: $input) { files { ... on MediaImage { id image { url } } } userErrors { message } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/MediaImage/1072273202\",\n \"originalSource\": \"https://example.com/image.jpg\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on MediaImage {\n id\n image {\n url\n }\n }\n }\n userErrors {\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/MediaImage/1072273202\",\n \"originalSource\": \"https://example.com/image.jpg\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on MediaImage {\n id\n image {\n url\n }\n }\n }\n userErrors {\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/MediaImage/1072273202\",\n \"originalSource\": \"https://example.com/image.jpg\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on MediaImage {\n id\n image {\n url\n }\n }\n }\n userErrors {\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/MediaImage/1072273202\",\n \"originalSource\": \"https://example.com/image.jpg\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n ... on MediaImage {\n id\n image {\n url\n }\n }\n }\n userErrors {\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/MediaImage/1072273202\",\n \"originalSource\" => \"https://example.com/image.jpg\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
},
{
"example": {
"type_name": "fileupdate",
"title": "Updating a file that doesn't exist returns an error",
"description": "Updating the alt text of a file that doesn't exist returns an error",
"query_string": "mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n alt\n ... on GenericFile {\n id\n }\n }\n userErrors {\n message\n }\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/GenericFile/1",
"alt": "new alt text"
}
},
"response": {
"data": {
"fileUpdate": {
"files": [],
"userErrors": [
{
"message": "File id [\"gid://shopify/GenericFile/1\"] does not exist."
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/file_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fileUpdate($input: [FileUpdateInput!]!) { fileUpdate(files: $input) { files { alt ... on GenericFile { id } } userErrors { message } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1\",\n \"alt\": \"new alt text\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n alt\n ... on GenericFile {\n id\n }\n }\n userErrors {\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1\",\n \"alt\": \"new alt text\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n alt\n ... on GenericFile {\n id\n }\n }\n userErrors {\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1\",\n \"alt\": \"new alt text\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n alt\n ... on GenericFile {\n id\n }\n }\n userErrors {\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GenericFile/1\",\n \"alt\": \"new alt text\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation fileUpdate($input: [FileUpdateInput!]!) {\n fileUpdate(files: $input) {\n files {\n alt\n ... on GenericFile {\n id\n }\n }\n userErrors {\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/GenericFile/1\",\n \"alt\" => \"new alt text\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
}
]