urlRedirectDelete

mutation

Requires write_online_store_navigation access scope.

Deletes a UrlRedirect object.

Arguments

Anchor to idid • ID!required: The ID of the redirect to delete.

Was this section helpful?

Anchor to UrlRedirectDeletePayload returnsUrlRedirectDeletePayload returns

Anchor to deletedUrlRedirectIddeletedUrlRedirectId • ID: The ID of the deleted redirect.
Anchor to userErrorsuserErrors • [UrlRedirectUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Deletes a redirect
urlRedirectDelete reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation UrlRedirectDelete($id: ID!) {
6    urlRedirectDelete(id: $id) {
7      deletedUrlRedirectId
8      userErrors {
9        field
10        message
11      }
12    }
13  }`,
14  {
15    variables: {
16      "id": "gid://shopify/UrlRedirect/905192165"
17    },
18  },
19);
20
21const data = await response.json();
22

mutation UrlRedirectDelete($id: ID!) {
  urlRedirectDelete(id: $id) {
    deletedUrlRedirectId
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UrlRedirectDelete($id: ID!) { urlRedirectDelete(id: $id) { deletedUrlRedirectId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/UrlRedirect/905192165"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation UrlRedirectDelete($id: ID!) {
    urlRedirectDelete(id: $id) {
      deletedUrlRedirectId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/UrlRedirect/905192165"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UrlRedirectDelete($id: ID!) {
      urlRedirectDelete(id: $id) {
        deletedUrlRedirectId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/UrlRedirect/905192165"
    },
  },
});

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 UrlRedirectDelete($id: ID!) {
    urlRedirectDelete(id: $id) {
      deletedUrlRedirectId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/UrlRedirect/905192165"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/UrlRedirect/905192165"
3}

Response

JSON

1{
2  "urlRedirectDelete": {
3    "deletedUrlRedirectId": "gid://shopify/UrlRedirect/905192165",
4    "userErrors": []
5  }
6}