Skip to content

Update blog settings

PUT
/stores/{storeRef}/blog/settings
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

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
is_enabled

Whether the blog is shown on the storefront.

boolean
blog_title

Title of the blog.

string
blog_description

Description of the blog.

string
posts_per_page

Number of posts per page on the storefront.

number
allow_comments

Whether visitors can comment.

boolean
moderate_comments

Whether visitor comments wait for approval before they are shown.

boolean
show_author

Whether the author is shown on posts.

boolean
show_reading_time

Whether the reading time is shown on posts.

boolean
enable_rss

Whether an RSS feed is offered.

boolean
custom_css

Custom CSS applied to the blog.

string

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"
}
Media typeapplication/json
object
id
required

Settings ID.

number
is_enabled

Whether the blog is shown on the storefront.

boolean
nullable
blog_title

Title of the blog.

string
nullable
blog_description

Description of the blog, or null.

string
nullable
posts_per_page

Number of posts per page on the storefront.

number
nullable
allow_comments

Whether visitors can comment.

boolean
nullable
moderate_comments

Whether visitor comments wait for approval before they are shown.

boolean
nullable
show_author

Whether the author is shown on posts.

boolean
nullable
show_reading_time

Whether the reading time is shown on posts.

boolean
nullable
enable_rss

Whether an RSS feed is offered.

boolean
nullable
custom_css

Custom CSS applied to the blog, or null.

string
nullable
created_at

When the settings were created, as an ISO 8601 timestamp.

string
nullable
updated_at

When the settings were last updated, as an ISO 8601 timestamp.

string
nullable

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}