Choose a version:

blogUpdate

mutation

Requires Any of write_content, write_online_store_pages access scopes.

Updates an existing blog's configuration and settings. This mutation allows merchants to modify blog properties to keep their content strategy current.

For example, a merchant might update their blog's title from "Company News" to "Sustainability Stories" when shifting their content focus, or modify the handle to improve URL structure.

Use the blogUpdate mutation to:

Change blog titles for rebranding
Modify blog handles for better URLs
Adjust comment settings and moderation preferences

The mutation returns the updated blog with any validation errors.

Anchor to Arguments

Arguments

Anchor to blogblog

•BlogUpdateInput!

required

The properties of the blog to be updated.

Anchor to idid

•ID!

required

The ID of the blog to be updated.

Was this section helpful?

Anchor to BlogUpdatePayload returnsBlogUpdatePayload returns

Anchor to blogblog •Blog: The blog that was updated.
Anchor to userErrorsuserErrors •[BlogUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Modify an existing Blog

Query

mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
  blogUpdate(id: $id, blog: $blog) {
    blog {
      id
      title
      handle
      templateSuffix
      commentPolicy
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Blog/389767568",
  "blog": {
    "title": "Updated Blog Title",
    "handle": "updated-blog-title",
    "templateSuffix": "updated_template",
    "commentPolicy": "MODERATED"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) { blogUpdate(id: $id, blog: $blog) { blog { id title handle templateSuffix commentPolicy } userErrors { code field message } } }",
 "variables": {
    "id": "gid://shopify/Blog/389767568",
    "blog": {
      "title": "Updated Blog Title",
      "handle": "updated-blog-title",
      "templateSuffix": "updated_template",
      "commentPolicy": "MODERATED"
    }
  }
}'

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 UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
    blogUpdate(id: $id, blog: $blog) {
      blog {
        id
        title
        handle
        templateSuffix
        commentPolicy
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Blog/389767568",
        "blog": {
            "title": "Updated Blog Title",
            "handle": "updated-blog-title",
            "templateSuffix": "updated_template",
            "commentPolicy": "MODERATED"
        }
    },
  },
  );
  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 UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
    blogUpdate(id: $id, blog: $blog) {
      blog {
        id
        title
        handle
        templateSuffix
        commentPolicy
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Blog/389767568",
  "blog": {
    "title": "Updated Blog Title",
    "handle": "updated-blog-title",
    "templateSuffix": "updated_template",
    "commentPolicy": "MODERATED"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
      blogUpdate(id: $id, blog: $blog) {
        blog {
          id
          title
          handle
          templateSuffix
          commentPolicy
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Blog/389767568",
        "blog": {
            "title": "Updated Blog Title",
            "handle": "updated-blog-title",
            "templateSuffix": "updated_template",
            "commentPolicy": "MODERATED"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
  blogUpdate(id: $id, blog: $blog) {
    blog {
      id
      title
      handle
      templateSuffix
      commentPolicy
    }
    userErrors {
      code
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/Blog/389767568",
  "blog": {
    "title": "Updated Blog Title",
    "handle": "updated-blog-title",
    "templateSuffix": "updated_template",
    "commentPolicy": "MODERATED"
  }
}'

Response

{
  "blogUpdate": {
    "blog": {
      "id": "gid://shopify/Blog/389767568",
      "title": "Updated Blog Title",
      "handle": "updated-blog-title",
      "templateSuffix": "updated_template",
      "commentPolicy": "MODERATED"
    },
    "userErrors": []
  }
}

blogUpdate 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 UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {

blogUpdate(id: $id, blog: $blog) {

blog {

title

handle

templateSuffix

commentPolicy

}

userErrors {

code

field

message

}

}`,

{

variables: {

"id": "gid://shopify/Blog/389767568",

"blog": {

"title": "Updated Blog Title",

"handle": "updated-blog-title",

"templateSuffix": "updated_template",

"commentPolicy": "MODERATED"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
  blogUpdate(id: $id, blog: $blog) {
    blog {
      id
      title
      handle
      templateSuffix
      commentPolicy
    }
    userErrors {
      code
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) { blogUpdate(id: $id, blog: $blog) { blog { id title handle templateSuffix commentPolicy } userErrors { code field message } } }",
 "variables": {
    "id": "gid://shopify/Blog/389767568",
    "blog": {
      "title": "Updated Blog Title",
      "handle": "updated-blog-title",
      "templateSuffix": "updated_template",
      "commentPolicy": "MODERATED"
    }
  }
}'

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 UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
    blogUpdate(id: $id, blog: $blog) {
      blog {
        id
        title
        handle
        templateSuffix
        commentPolicy
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Blog/389767568",
        "blog": {
            "title": "Updated Blog Title",
            "handle": "updated-blog-title",
            "templateSuffix": "updated_template",
            "commentPolicy": "MODERATED"
        }
    },
  },
  );
  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 UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
      blogUpdate(id: $id, blog: $blog) {
        blog {
          id
          title
          handle
          templateSuffix
          commentPolicy
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Blog/389767568",
        "blog": {
            "title": "Updated Blog Title",
            "handle": "updated-blog-title",
            "templateSuffix": "updated_template",
            "commentPolicy": "MODERATED"
        }
    },
  },
});

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 UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
    blogUpdate(id: $id, blog: $blog) {
      blog {
        id
        title
        handle
        templateSuffix
        commentPolicy
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Blog/389767568",
  "blog": {
    "title": "Updated Blog Title",
    "handle": "updated-blog-title",
    "templateSuffix": "updated_template",
    "commentPolicy": "MODERATED"
  }
}

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

Shopify CLI

shopify app execute \
--query \
'mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {
  blogUpdate(id: $id, blog: $blog) {
    blog {
      id
      title
      handle
      templateSuffix
      commentPolicy
    }
    userErrors {
      code
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/Blog/389767568",
  "blog": {
    "title": "Updated Blog Title",
    "handle": "updated-blog-title",
    "templateSuffix": "updated_template",
    "commentPolicy": "MODERATED"
  }
}'

Input variables

JSON

{

"id": "gid://shopify/Blog/389767568",

"blog": {

"title": "Updated Blog Title",

"handle": "updated-blog-title",

"templateSuffix": "updated_template",

"commentPolicy": "MODERATED"

}

Response

JSON

{

"blogUpdate": {

"blog": {

"id": "gid://shopify/Blog/389767568",

"title": "Updated Blog Title",

"handle": "updated-blog-title",

"templateSuffix": "updated_template",

"commentPolicy": "MODERATED"

"userErrors": []

}