Choose a version:

urlRedirectUpdate

mutation

Requires write_online_store_navigation access scope.

Updates a URL redirect.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The ID of the URL redirect to update.

Anchor to urlRedirecturlRedirect

•UrlRedirectInput!

required

The input fields required to update the URL redirect.

Show input fields

Was this section helpful?

Anchor to UrlRedirectUpdatePayload returnsUrlRedirectUpdatePayload returns

Anchor to urlRedirecturlRedirect •UrlRedirect: Returns the updated URL redirect.

Show fields
Anchor to userErrorsuserErrors •[UrlRedirectUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

Updates an existing redirect

Query

mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
  urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
    urlRedirect {
      id
      path
      target
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/UrlRedirect/905192165",
  "urlRedirect": {
    "path": "/thepath",
    "target": "/thetarget"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) { urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) { urlRedirect { id path target } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/UrlRedirect/905192165",
    "urlRedirect": {
      "path": "/thepath",
      "target": "/thetarget"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
    urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
      urlRedirect {
        id
        path
        target
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/UrlRedirect/905192165",
        "urlRedirect": {
            "path": "/thepath",
            "target": "/thetarget"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

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 UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
    urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
      urlRedirect {
        id
        path
        target
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/UrlRedirect/905192165",
  "urlRedirect": {
    "path": "/thepath",
    "target": "/thetarget"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
      urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
        urlRedirect {
          id
          path
          target
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/UrlRedirect/905192165",
        "urlRedirect": {
            "path": "/thepath",
            "target": "/thetarget"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
  urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
    urlRedirect {
      id
      path
      target
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/UrlRedirect/905192165",
  "urlRedirect": {
    "path": "/thepath",
    "target": "/thetarget"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-01/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
        urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
          urlRedirect {
            id
            path
            target
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/UrlRedirect/905192165",
        "urlRedirect": {
            "path": "/thepath",
            "target": "/thetarget"
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "urlRedirectUpdate": {
    "urlRedirect": {
      "id": "gid://shopify/UrlRedirect/905192165",
      "path": "/thepath",
      "target": "/thetarget"
    },
    "userErrors": []
  }
}

urlRedirectUpdate reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {

urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {

urlRedirect {

path

target

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/UrlRedirect/905192165",

"urlRedirect": {

"path": "/thepath",

"target": "/thetarget"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
  urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
    urlRedirect {
      id
      path
      target
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) { urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) { urlRedirect { id path target } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/UrlRedirect/905192165",
    "urlRedirect": {
      "path": "/thepath",
      "target": "/thetarget"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
    urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
      urlRedirect {
        id
        path
        target
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/UrlRedirect/905192165",
        "urlRedirect": {
            "path": "/thepath",
            "target": "/thetarget"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
      urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
        urlRedirect {
          id
          path
          target
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/UrlRedirect/905192165",
        "urlRedirect": {
            "path": "/thepath",
            "target": "/thetarget"
        }
    },
  },
});

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 UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
    urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
      urlRedirect {
        id
        path
        target
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/UrlRedirect/905192165",
  "urlRedirect": {
    "path": "/thepath",
    "target": "/thetarget"
  }
}

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

Shopify CLI

shopify app execute \
--query \
'mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
  urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
    urlRedirect {
      id
      path
      target
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/UrlRedirect/905192165",
  "urlRedirect": {
    "path": "/thepath",
    "target": "/thetarget"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-01/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation UrlRedirectUpdate($id: ID!, $urlRedirect: UrlRedirectInput!) {
        urlRedirectUpdate(id: $id, urlRedirect: $urlRedirect) {
          urlRedirect {
            id
            path
            target
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/UrlRedirect/905192165",
        "urlRedirect": {
            "path": "/thepath",
            "target": "/thetarget"
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"id": "gid://shopify/UrlRedirect/905192165",

"urlRedirect": {

"path": "/thepath",

"target": "/thetarget"

}

Response

JSON

{

"urlRedirectUpdate": {

"urlRedirect": {

"id": "gid://shopify/UrlRedirect/905192165",

"path": "/thepath",

"target": "/thetarget"

"userErrors": []

}