Choose a version:

scriptTagUpdate

mutation

Requires write_script_tags access scope.

Theme app extensions

If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with vintage themes. Learn more.

Script tag deprecation

Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.

Updates a script tag.

Arguments

Anchor to idid •ID! required: The ID of the script tag to update.
Anchor to inputinput •ScriptTagInput! required: Specifies the input fields for a script tag.

Was this section helpful?

Anchor to ScriptTagUpdatePayload returnsScriptTagUpdatePayload returns

Anchor to scriptTagscriptTag •ScriptTag: The script tag that was updated.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Updates a script tag

Query

mutation ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) {
  scriptTagUpdate(id: $id, input: $input) {
    scriptTag {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/ScriptTag/421379493",
  "input": {
    "src": "https://js.example.org/updated.js",
    "displayScope": "ONLINE_STORE"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) { scriptTagUpdate(id: $id, input: $input) { scriptTag { id cache createdAt displayScope src updatedAt } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/ScriptTag/421379493",
    "input": {
      "src": "https://js.example.org/updated.js",
      "displayScope": "ONLINE_STORE"
    }
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  mutation ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) {
    scriptTagUpdate(id: $id, input: $input) {
      scriptTag {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/ScriptTag/421379493",
      "input": {
        "src": "https://js.example.org/updated.js",
        "displayScope": "ONLINE_STORE"
      }
    },
  },
);

const data = await response.json();

Ruby

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 ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) {
    scriptTagUpdate(id: $id, input: $input) {
      scriptTag {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ScriptTag/421379493",
  "input": {
    "src": "https://js.example.org/updated.js",
    "displayScope": "ONLINE_STORE"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) {
      scriptTagUpdate(id: $id, input: $input) {
        scriptTag {
          id
          cache
          createdAt
          displayScope
          src
          updatedAt
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/ScriptTag/421379493",
      "input": {
        "src": "https://js.example.org/updated.js",
        "displayScope": "ONLINE_STORE"
      }
    },
  },
});

Response

{
  "scriptTagUpdate": {
    "scriptTag": {
      "id": "gid://shopify/ScriptTag/421379493",
      "cache": false,
      "createdAt": "2024-12-18T11:35:33Z",
      "displayScope": "ONLINE_STORE",
      "src": "https://js.example.org/updated.js",
      "updatedAt": "2024-12-18T11:37:33Z"
    },
    "userErrors": []
  }
}

scriptTagUpdate reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) {

scriptTagUpdate(id: $id, input: $input) {

scriptTag {

cache

createdAt

displayScope

src

updatedAt

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/ScriptTag/421379493",

"input": {

"src": "https://js.example.org/updated.js",

"displayScope": "ONLINE_STORE"

}

);

const data = await response.json();

mutation ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) {
  scriptTagUpdate(id: $id, input: $input) {
    scriptTag {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) { scriptTagUpdate(id: $id, input: $input) { scriptTag { id cache createdAt displayScope src updatedAt } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/ScriptTag/421379493",
    "input": {
      "src": "https://js.example.org/updated.js",
      "displayScope": "ONLINE_STORE"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) {
    scriptTagUpdate(id: $id, input: $input) {
      scriptTag {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/ScriptTag/421379493",
      "input": {
        "src": "https://js.example.org/updated.js",
        "displayScope": "ONLINE_STORE"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) {
      scriptTagUpdate(id: $id, input: $input) {
        scriptTag {
          id
          cache
          createdAt
          displayScope
          src
          updatedAt
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/ScriptTag/421379493",
      "input": {
        "src": "https://js.example.org/updated.js",
        "displayScope": "ONLINE_STORE"
      }
    },
  },
});

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 ScriptTagUpdate($id: ID!, $input: ScriptTagInput!) {
    scriptTagUpdate(id: $id, input: $input) {
      scriptTag {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ScriptTag/421379493",
  "input": {
    "src": "https://js.example.org/updated.js",
    "displayScope": "ONLINE_STORE"
  }
}

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

Input variables

JSON

{

"id": "gid://shopify/ScriptTag/421379493",

"input": {

"src": "https://js.example.org/updated.js",

"displayScope": "ONLINE_STORE"

}

Response

JSON

{

"scriptTagUpdate": {

"scriptTag": {

"id": "gid://shopify/ScriptTag/421379493",

"cache": false,

"createdAt": "2024-12-18T11:35:33Z",

"displayScope": "ONLINE_STORE",

"src": "https://js.example.org/updated.js",

"updatedAt": "2024-12-18T11:37:33Z"

"userErrors": []

}