About the Blog Settings API

The Blog Settings API manages the label of a site's all-posts feed and the settings that control comments.

With the Blog Settings API, you can:

• Read the site's blog settings.
• Update the all-posts feed label, including a translation for another language.
• Turn comments on or off, allow comments from visitors who are not signed in, and require a rating with each comment.

All-posts feed label

allPostsFeedLabel is the only translatable field. Comments are not translated.

Specify language to read or write the label for that language. On Get Blog Settings, an omitted language uses the language of the current request when the request includes one, and otherwise uses the primary language. If that language has no translation, the primary label is returned.

On Update Blog Settings, an omitted language updates the primary label. Specifying the site's primary language also updates the primary label. Specifying a secondary language updates only that language's label and leaves the primary label unchanged. An unsupported language is rejected.

Before you begin

It's important to note the following points before starting to code:

• The site must have the Wix Blog app installed.
• A site has one blog settings object. Get Blog Settings creates the default blog settings when the site has none yet. The default feed label is All posts, comments are turned on, anonymous comments are turned off, and ratings are turned off.
• To update comments, include enabled, anonymousEnabled, ratingsEnabled, and ratingsMandatory together. A partial comments object is rejected.
• Update Blog Settings changes only the fields included in the request.

Use cases

• Localize the all-posts feed label
• Require a rating on comments

Terminology

• Blog settings: The single object that stores a site's all-posts feed label and comment settings.
• All-posts feed: The page that lists every blog post on the site. Its label is allPostsFeedLabel.