fileUpdate

mutation

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

Updates an existing file asset that was uploaded to Shopify.

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?

Update a file
Update a generic file
Update an image
Updating a file that doesn't exist returns an error
fileUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation FileUpdate($input: [FileUpdateInput!]!) {
6    fileUpdate(files: $input) {
7      userErrors {
8        code
9        field
10        message
11      }
12      files {
13        alt
14      }
15    }
16  }`,
17  {
18    variables: {
19      "input": {
20        "id": "gid://shopify/GenericFile/1072273203",
21        "alt": "new alt text"
22      }
23    },
24  },
25);
26
27const data = await response.json();
28

mutation FileUpdate($input: [FileUpdateInput!]!) {
  fileUpdate(files: $input) {
    userErrors {
      code
      field
      message
    }
    files {
      alt
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation FileUpdate($input: [FileUpdateInput!]!) { fileUpdate(files: $input) { userErrors { code field message } files { alt } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/GenericFile/1072273203",
      "alt": "new alt text"
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation FileUpdate($input: [FileUpdateInput!]!) {
    fileUpdate(files: $input) {
      userErrors {
        code
        field
        message
      }
      files {
        alt
      }
    }
  }`,
  {
    variables: {
      "input": {
        "id": "gid://shopify/GenericFile/1072273203",
        "alt": "new alt text"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation FileUpdate($input: [FileUpdateInput!]!) {
      fileUpdate(files: $input) {
        userErrors {
          code
          field
          message
        }
        files {
          alt
        }
      }
    }`,
    "variables": {
      "input": {
        "id": "gid://shopify/GenericFile/1072273203",
        "alt": "new alt text"
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation FileUpdate($input: [FileUpdateInput!]!) {
    fileUpdate(files: $input) {
      userErrors {
        code
        field
        message
      }
      files {
        alt
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/GenericFile/1072273203",
    "alt": "new alt text"
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "input": {
3    "id": "gid://shopify/GenericFile/1072273203",
4    "alt": "new alt text"
5  }
6}

Response

JSON

1{
2  "fileUpdate": {
3    "userErrors": [],
4    "files": [
5      {
6        "alt": "new alt text"
7      }
8    ]
9  }
10}