blogUpdate

mutation

Code examples for MUTATION: blogUpdate

Query Reference for MUTATION: blogUpdate

"mutation blogUpdate($blog: BlogUpdateInput!, $id: ID!) {\n  blogUpdate(blog: $blog, id: $id) {\n    blog {\n      # Blog fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: blogUpdate

"{\n  \"blog\": {\n    \"commentPolicy\": \"AUTO_PUBLISHED\",\n    \"handle\": \"<your-handle>\",\n    \"metafields\": [\n      {\n        \"description\": \"<your-description>\",\n        \"id\": \"gid://shopify/<objectName>/10079785100\",\n        \"key\": \"<your-key>\",\n        \"namespace\": \"<your-namespace>\",\n        \"type\": \"<your-type>\",\n        \"value\": \"<your-value>\"\n      }\n    ],\n    \"redirectArticles\": true,\n    \"redirectNewHandle\": true,\n    \"templateSuffix\": \"<your-templateSuffix>\",\n    \"title\": \"<your-title>\"\n  },\n  \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: blogUpdate

"input BlogUpdateInput {\n  commentPolicy: CommentPolicy\n  handle: String\n  metafields: [MetafieldInput!]\n  redirectArticles: Boolean\n  redirectNewHandle: Boolean\n  templateSuffix: String\n  title: String\n}\n\ninput MetafieldInput {\n  description: String\n  id: ID\n  key: String\n  namespace: String\n  type: String\n  value: String\n}\n"

Display Examples for MUTATION: blogUpdate

[
  {
    "example": {
      "type_name": "blogupdate",
      "title": "Update an existing blog",
      "description": "Updating a blog with new details and proper permissions results in a successful update and returns the updated blog details.",
      "query_string": "mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {\n  blogUpdate(id: $id, blog: $blog) {\n    blog {\n      id\n      title\n      handle\n      templateSuffix\n      commentPolicy\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/Blog/397675442",
        "blog": {
          "title": "Updated Blog Title",
          "handle": "updated-blog-title",
          "templateSuffix": "updated_template",
          "commentPolicy": "MODERATED"
        }
      },
      "response": {
        "data": {
          "blogUpdate": {
            "blog": {
              "id": "gid://shopify/Blog/397675442",
              "title": "Updated Blog Title",
              "handle": "updated-blog-title",
              "templateSuffix": "updated_template",
              "commentPolicy": "MODERATED"
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "unstable",
      "maximum_api_version": "unstable",
      "location": "/components/online_store/test/unit/graph_api/admin/mutations/blog_update_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) { blogUpdate(id: $id, blog: $blog) { blog { id title handle templateSuffix commentPolicy } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Blog/397675442\",\n    \"blog\": {\n      \"title\": \"Updated Blog Title\",\n      \"handle\": \"updated-blog-title\",\n      \"templateSuffix\": \"updated_template\",\n      \"commentPolicy\": \"MODERATED\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {\n    blogUpdate(id: $id, blog: $blog) {\n      blog {\n        id\n        title\n        handle\n        templateSuffix\n        commentPolicy\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Blog/397675442\",\n      \"blog\": {\n        \"title\": \"Updated Blog Title\",\n        \"handle\": \"updated-blog-title\",\n        \"templateSuffix\": \"updated_template\",\n        \"commentPolicy\": \"MODERATED\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n",
      "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {\n    blogUpdate(id: $id, blog: $blog) {\n      blog {\n        id\n        title\n        handle\n        templateSuffix\n        commentPolicy\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Blog/397675442\",\n  \"blog\": {\n    \"title\": \"Updated Blog Title\",\n    \"handle\": \"updated-blog-title\",\n    \"templateSuffix\": \"updated_template\",\n    \"commentPolicy\": \"MODERATED\"\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {\n      blogUpdate(id: $id, blog: $blog) {\n        blog {\n          id\n          title\n          handle\n          templateSuffix\n          commentPolicy\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Blog/397675442\",\n      \"blog\": {\n        \"title\": \"Updated Blog Title\",\n        \"handle\": \"updated-blog-title\",\n        \"templateSuffix\": \"updated_template\",\n        \"commentPolicy\": \"MODERATED\"\n      }\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation UpdateBlog($id: ID!, $blog: BlogUpdateInput!) {\n    blogUpdate(id: $id, blog: $blog) {\n      blog {\n        id\n        title\n        handle\n        templateSuffix\n        commentPolicy\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Blog/397675442\",\n  \"blog\" => [\n    \"title\" => \"Updated Blog Title\",\n    \"handle\" => \"updated-blog-title\",\n    \"templateSuffix\" => \"updated_template\",\n    \"commentPolicy\" => \"MODERATED\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the blog to be updated.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/Blog/397675442\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "blog",
          "description": "The properties of the blog to be updated.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "BlogUpdateInput",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "BlogUpdateInput!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "blog",
        "argValue": " {\"title\":\"Updated Blog Title\",\"handle\":\"updated-blog-title\",\"templateSuffix\":\"updated_template\",\"commentPolicy\":\"MODERATED\"}",
        "typeKind": "MUTATION"
      }
    ]
  }
]