Category Object


A comments category allows you to define settings for a specific group of comments. For example, which site visitors can comment, react, and reply to a blog post or product page.

Properties
activeboolean

Whether the category is active and being used in a live site.


appIdstringimmutableformat GUID

ID of the app the category applies to.


createdDatestringRead-onlyformat date-time

Date and time the category was created.


customMarkedCommentLabelstringmaxLength 24

Custom label value for marked comments. See the description for markedCommentLabelType for more information about marked comments.


guestCommentingbooleandeprecated

Whether guest commenting is allowed.


guestReactionsbooleandeprecated

Whether guests can add reactions to comments.


idstringRead-onlyformat GUID

Category ID.


mainReactionReactionIcon

Type of icon to use as the main comment reaction.


markedCommentLabelTypestring

Default comment label for marked comments.

When a comment's marked field is set to true, it indicates that the comment has been flagged or marked for special attention. No additional automated behavior or action is taken with the comment. See the Comments Sample Flows for an example of handling marked comments.


namestring

Category name.


permissionsSettingsPermissionsSettings

Permissions settings for specific actions in the category.


ratingsSettingsRatingsSettings

Ratings settings.


reactionTypestring

Type of reactions available for comments.


repliesReactionTypestring

Type of reactions available for replies.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the category is updated. To prevent conflicting changes, the current revision must be passed when updating the category.


updatedDatestringRead-onlyformat date-time

Date and time the category was last updated.

Did this help?