Choose a version:

blogDelete

mutation

Requires Any of write_content, write_online_store_pages access scopes.

Permanently deletes a blog from a shop. This mutation removes the blog container and its organizational structure.

For example, when consolidating multiple seasonal blogs into a single year-round content strategy, merchants can use this mutation to remove unused blogs.

Use the blogDelete mutation to:

Remove unused or outdated blogs
Consolidate content organization
Clean up blog structure

The deletion is permanent and returns the deleted blog's ID for confirmation.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to BlogDeletePayload returnsBlogDeletePayload returns

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

Was this section helpful?

Examples

Delete an existing blog

Description

Deleting a blog with proper permissions results in the blog being removed from the store.

Query

mutation DeleteBlog($id: ID!) {
  blogDelete(id: $id) {
    deletedBlogId
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Blog/389767568"
}

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 DeleteBlog($id: ID!) { blogDelete(id: $id) { deletedBlogId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Blog/389767568"
  }
}'

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 DeleteBlog($id: ID!) {
    blogDelete(id: $id) {
      deletedBlogId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Blog/389767568"
    },
  },
  );
  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 DeleteBlog($id: ID!) {
    blogDelete(id: $id) {
      deletedBlogId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Blog/389767568"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteBlog($id: ID!) {
      blogDelete(id: $id) {
        deletedBlogId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Blog/389767568"
    },
  },
});

Response

{
  "blogDelete": {
    "deletedBlogId": "gid://shopify/Blog/389767568",
    "userErrors": []
  }
}

Remove an existing Blog

Query

mutation DeleteBlog($id: ID!) {
  blogDelete(id: $id) {
    deletedBlogId
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Blog/389767568"
}

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 DeleteBlog($id: ID!) { blogDelete(id: $id) { deletedBlogId userErrors { code field message } } }",
 "variables": {
    "id": "gid://shopify/Blog/389767568"
  }
}'

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 DeleteBlog($id: ID!) {
    blogDelete(id: $id) {
      deletedBlogId
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Blog/389767568"
    },
  },
  );
  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 DeleteBlog($id: ID!) {
    blogDelete(id: $id) {
      deletedBlogId
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Blog/389767568"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteBlog($id: ID!) {
      blogDelete(id: $id) {
        deletedBlogId
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Blog/389767568"
    },
  },
});

Response

{
  "blogDelete": {
    "deletedBlogId": "gid://shopify/Blog/389767568",
    "userErrors": []
  }
}

blogDelete 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 DeleteBlog($id: ID!) {

blogDelete(id: $id) {

deletedBlogId

userErrors {

field

message

}

}`,

{

variables: {

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

);

const json = await response.json();

return json.data;

}

GQL

mutation DeleteBlog($id: ID!) {
  blogDelete(id: $id) {
    deletedBlogId
    userErrors {
      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 DeleteBlog($id: ID!) { blogDelete(id: $id) { deletedBlogId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Blog/389767568"
  }
}'

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 DeleteBlog($id: ID!) {
    blogDelete(id: $id) {
      deletedBlogId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Blog/389767568"
    },
  },
  );
  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 DeleteBlog($id: ID!) {
      blogDelete(id: $id) {
        deletedBlogId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Blog/389767568"
    },
  },
});

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 DeleteBlog($id: ID!) {
    blogDelete(id: $id) {
      deletedBlogId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Blog/389767568"
}

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

Input variables

JSON

{

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

}

Response

JSON

{

"blogDelete": {

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

"userErrors": []

}