Update blog settings
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/blog/settings';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"is_enabled":true,"blog_title":"example","blog_description":"example","posts_per_page":1,"allow_comments":true,"moderate_comments":true,"show_author":true,"show_reading_time":true,"enable_rss":true,"custom_css":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://apibase.ecomweb.app/api/v1/stores/example/blog/settings \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "is_enabled": true, "blog_title": "example", "blog_description": "example", "posts_per_page": 1, "allow_comments": true, "moderate_comments": true, "show_author": true, "show_reading_time": true, "enable_rss": true, "custom_css": "example" }'Updates the fields you send, creating the settings the first time. Returns the settings after the change.
Required scopes: write:blog
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Whether the blog is shown on the storefront.
Title of the blog.
Description of the blog.
Number of posts per page on the storefront.
Whether visitors can comment.
Whether visitor comments wait for approval before they are shown.
Whether the author is shown on posts.
Whether the reading time is shown on posts.
Whether an RSS feed is offered.
Custom CSS applied to the blog.
Example generated
{ "is_enabled": true, "blog_title": "example", "blog_description": "example", "posts_per_page": 1, "allow_comments": true, "moderate_comments": true, "show_author": true, "show_reading_time": true, "enable_rss": true, "custom_css": "example"}Responses
Section titled “Responses”object
Settings ID.
Whether the blog is shown on the storefront.
Title of the blog.
Description of the blog, or null.
Number of posts per page on the storefront.
Whether visitors can comment.
Whether visitor comments wait for approval before they are shown.
Whether the author is shown on posts.
Whether the reading time is shown on posts.
Whether an RSS feed is offered.
Custom CSS applied to the blog, or null.
When the settings were created, as an ISO 8601 timestamp.
When the settings were last updated, as an ISO 8601 timestamp.
Example generated
{ "id": 1, "is_enabled": true, "blog_title": "example", "blog_description": "example", "posts_per_page": 1, "allow_comments": true, "moderate_comments": true, "show_author": true, "show_reading_time": true, "enable_rss": true, "custom_css": "example", "created_at": "example", "updated_at": "example"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}