Choose a version:

pageUpdate

mutation

Requires Any of write_content, write_online_store_pages access scopes.

Updates an existing page's content and settings.

For example, merchants can update their "Shipping Policy" page when rates change, or refresh their "About Us" page with new team information.

Use the pageUpdate mutation to:

Update page content and titles
Modify publication status
Change page handles for URL structure
Adjust template settings

The mutation supports partial updates, allowing specific changes while preserving other page properties.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The ID of the page to be updated.

Anchor to pagepage

•PageUpdateInput!

required

The properties of the page to be updated.

Was this section helpful?

Anchor to PageUpdatePayload returnsPageUpdatePayload returns

Anchor to pagepage •Page: The page that was updated.
Anchor to userErrorsuserErrors •[PageUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Updates a page

Query

mutation UpdatePage($id: ID!, $page: PageUpdateInput!) {
  pageUpdate(id: $id, page: $page) {
    page {
      id
      title
      handle
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Page/602767277",
  "page": {
    "title": "This is the Title",
    "handle": "this-is-the-handle"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UpdatePage($id: ID!, $page: PageUpdateInput!) { pageUpdate(id: $id, page: $page) { page { id title handle } userErrors { code field message } } }",
 "variables": {
    "id": "gid://shopify/Page/602767277",
    "page": {
      "title": "This is the Title",
      "handle": "this-is-the-handle"
    }
  }
}'

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 UpdatePage($id: ID!, $page: PageUpdateInput!) {
    pageUpdate(id: $id, page: $page) {
      page {
        id
        title
        handle
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Page/602767277",
        "page": {
            "title": "This is the Title",
            "handle": "this-is-the-handle"
        }
    },
  },
  );
  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 UpdatePage($id: ID!, $page: PageUpdateInput!) {
    pageUpdate(id: $id, page: $page) {
      page {
        id
        title
        handle
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Page/602767277",
  "page": {
    "title": "This is the Title",
    "handle": "this-is-the-handle"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UpdatePage($id: ID!, $page: PageUpdateInput!) {
      pageUpdate(id: $id, page: $page) {
        page {
          id
          title
          handle
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Page/602767277",
        "page": {
            "title": "This is the Title",
            "handle": "this-is-the-handle"
        }
    },
  },
});

Response

{
  "pageUpdate": {
    "page": {
      "id": "gid://shopify/Page/602767277",
      "title": "This is the Title",
      "handle": "this-is-the-handle"
    },
    "userErrors": []
  }
}

Updating a page to have a new title

Description

Updates a page's title successfully.

Query

mutation UpdatePage($id: ID!, $page: PageUpdateInput!) {
  pageUpdate(id: $id, page: $page) {
    page {
      id
      title
      handle
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Page/602767277",
  "page": {
    "title": "This is the Title",
    "handle": "this-is-the-handle"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UpdatePage($id: ID!, $page: PageUpdateInput!) { pageUpdate(id: $id, page: $page) { page { id title handle } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Page/602767277",
    "page": {
      "title": "This is the Title",
      "handle": "this-is-the-handle"
    }
  }
}'

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 UpdatePage($id: ID!, $page: PageUpdateInput!) {
    pageUpdate(id: $id, page: $page) {
      page {
        id
        title
        handle
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Page/602767277",
        "page": {
            "title": "This is the Title",
            "handle": "this-is-the-handle"
        }
    },
  },
  );
  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 UpdatePage($id: ID!, $page: PageUpdateInput!) {
    pageUpdate(id: $id, page: $page) {
      page {
        id
        title
        handle
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Page/602767277",
  "page": {
    "title": "This is the Title",
    "handle": "this-is-the-handle"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UpdatePage($id: ID!, $page: PageUpdateInput!) {
      pageUpdate(id: $id, page: $page) {
        page {
          id
          title
          handle
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Page/602767277",
        "page": {
            "title": "This is the Title",
            "handle": "this-is-the-handle"
        }
    },
  },
});

Response

{
  "pageUpdate": {
    "page": {
      "id": "gid://shopify/Page/602767277",
      "title": "This is the Title",
      "handle": "this-is-the-handle"
    },
    "userErrors": []
  }
}

pageUpdate reference

Examples

Open in GraphiQL

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

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

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

const response = await admin.graphql(

`#graphql

mutation UpdatePage($id: ID!, $page: PageUpdateInput!) {

pageUpdate(id: $id, page: $page) {

page {

title

handle

}

userErrors {

code

field

message

}

}`,

{

variables: {

"id": "gid://shopify/Page/602767277",

"page": {

"title": "This is the Title",

"handle": "this-is-the-handle"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation UpdatePage($id: ID!, $page: PageUpdateInput!) {
  pageUpdate(id: $id, page: $page) {
    page {
      id
      title
      handle
    }
    userErrors {
      code
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UpdatePage($id: ID!, $page: PageUpdateInput!) { pageUpdate(id: $id, page: $page) { page { id title handle } userErrors { code field message } } }",
 "variables": {
    "id": "gid://shopify/Page/602767277",
    "page": {
      "title": "This is the Title",
      "handle": "this-is-the-handle"
    }
  }
}'

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 UpdatePage($id: ID!, $page: PageUpdateInput!) {
    pageUpdate(id: $id, page: $page) {
      page {
        id
        title
        handle
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Page/602767277",
        "page": {
            "title": "This is the Title",
            "handle": "this-is-the-handle"
        }
    },
  },
  );
  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 UpdatePage($id: ID!, $page: PageUpdateInput!) {
      pageUpdate(id: $id, page: $page) {
        page {
          id
          title
          handle
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Page/602767277",
        "page": {
            "title": "This is the Title",
            "handle": "this-is-the-handle"
        }
    },
  },
});

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 UpdatePage($id: ID!, $page: PageUpdateInput!) {
    pageUpdate(id: $id, page: $page) {
      page {
        id
        title
        handle
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Page/602767277",
  "page": {
    "title": "This is the Title",
    "handle": "this-is-the-handle"
  }
}

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

Input variables

JSON

{

"id": "gid://shopify/Page/602767277",

"page": {

"title": "This is the Title",

"handle": "this-is-the-handle"

}

Response

JSON

{

"pageUpdate": {

"page": {

"id": "gid://shopify/Page/602767277",

"title": "This is the Title",

"handle": "this-is-the-handle"

"userErrors": []

}