pageDelete

mutation

Requires Any of write_content, write_online_store_pages access scopes.

Deletes a page.

Arguments

Anchor to idid • ID!required: The ID of the page to be deleted.

Was this section helpful?

Anchor to PageDeletePayload returnsPageDeletePayload returns

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

Was this section helpful?

Deletes a page
pageDelete reference

Examples

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

mutation DeletePage($id: ID!) {
  pageDelete(id: $id) {
    deletedPageId
    userErrors {
      code
      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 DeletePage($id: ID!) { pageDelete(id: $id) { deletedPageId userErrors { code field message } } }",
 "variables": {
    "id": "gid://shopify/Page/602767277"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation DeletePage($id: ID!) {
    pageDelete(id: $id) {
      deletedPageId
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Page/602767277"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeletePage($id: ID!) {
      pageDelete(id: $id) {
        deletedPageId
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Page/602767277"
    },
  },
});

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 DeletePage($id: ID!) {
    pageDelete(id: $id) {
      deletedPageId
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Page/602767277"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/Page/602767277"
3}

Response

JSON

1{
2  "pageDelete": {
3    "deletedPageId": "gid://shopify/Page/602767277",
4    "userErrors": []
5  }
6}