Blog settings control who can submit comments and whether new comments require moderation. Reads require read_blog; writes require write_blog. comments_mode is disabled, all, or registered.
Updates preserve omitted fields. At least one setting must be supplied. Disabling comments hides existing comments and sets public counts to zero without deleting records. Re-enabling comments restores their visibility according to their moderation status. These endpoints configure comments; they do not create shopper comments.
Endpoints#
Get blog settings
Get blog comment settings.
Returns the supported modes as well as the store's current mode and moderation choice.
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
Update blog settings
Update blog comment settings.
This is an atomic patch. Omitted fields stay unchanged. Disabling comments hides existing comments and reports zero counts without deleting them.
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Body parameters
| Name | Type | Description |
|---|---|---|
comments_mode
|
string |
Who may comment: disabled, all, or registered. |
comments_moderation
|
boolean |
Whether new comments wait for merchant approval. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
-
400STORE_API_INVALID_REQUEST_BODYThe request body is malformed or contains an unknown field.
-
400BLOG_SETTINGS_NO_FIELDS_TO_UPDATENo supported settings field was supplied.
-
400BLOG_COMMENTS_MODE_INVALIDComments mode is not disabled, all, or registered.
Webhook events#
Subscribe when an integration mirrors comment availability or moderation behavior. The settings update and its event commit together.
Blog settings updated
Fired when blog comment settings change.
Payload fields
| Field | Type | Description |
|---|---|---|
settings.comments_mode |
string |
Always present |
settings.comments_moderation |
boolean |
Selectable in the Payload builder |
settings.updated_at |
string |
Always present |