openapi: 3.2.0 info: title: engagement-suite Comment Boards API version: '1' servers: - url: https://cf-blast.livelikecdn.com/api/v1 security: - {} tags: - name: Comment Boards paths: /comment-boards/: post: summary: Create a Comment Board description: '' operationId: create-a-comment-board parameters: - name: Authorization in: header description: Bearer Token required: true schema: type: string requestBody: content: application/json: schema: type: object required: - custom_id properties: custom_id: type: string allow_comments: type: boolean description: This will determine whether comments are allowed in this board or not default: true replies_depth: type: integer description: This will determine the maximum number of nesting for a comment default: 1 format: int32 title: type: string description: Board title description: type: string custom_data: type: string description: 'Custom data is used for things like: Storing extra context for the comment board' content_filter: type: string description: 'To manage the type of comments allowed in a comment board, we provide two levels of content filtering. Each level determines how messages are moderated. **1.** `none`: No content filtering, all users can post freely. **2.**`filtered`: Profanity is automatically filtered. **3.** `ai`: message recognized by an AI model as objectionable, will be filtered.' default: none enum: - none - filtered - ai attributes: type: array items: properties: {} type: object description: 'list of comment board attributes in {"key": <>, "value": <>} format' responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"id\": \"eefa00d2-cf12-48de-99a0-3f10a1d3587a\",\n \"url\": \"https://cf-blast.livelikecdn.com/api/v1/comment-boards/eefa00d2-cf12-48de-99a0-3f10a1d3587a/\",\n \"client_id\": \"lom9db0XtQUhOZQq1vz8QPfSpiyyxppiUVGMcAje\",\n \"custom_id\": \"a0\",\n \"title\": \"User_Test\",\n \"custom_data\": null,\n \"description\": null,\n \"allow_comments\": true,\n \"replies_depth\": 2,\n \"comments_url\": \"https://cf-blast.livelikecdn.com/api/v1/comments/\",\n \"comment_detail_url_template\": \"https://cf-blast.livelikecdn.com/api/v1/comments/{comment_id}/\",\n \"created_by\": \"460c435b-d3b7-4add-bc63-628b0911f811\",\n \"created_at\": \"2022-12-21T10:58:46.151911Z\",\n \"reaction_space_id\": \"a0e8a202-0674-4124-b494-f5e32c056dc0\"\n}" schema: type: object properties: id: type: string example: eefa00d2-cf12-48de-99a0-3f10a1d3587a url: type: string example: https://cf-blast.livelikecdn.com/api/v1/comment-boards/eefa00d2-cf12-48de-99a0-3f10a1d3587a/ client_id: type: string example: lom9db0XtQUhOZQq1vz8QPfSpiyyxppiUVGMcAje custom_id: type: string example: a0 title: type: string example: User_Test custom_data: {} description: {} allow_comments: type: boolean example: true default: true replies_depth: type: integer example: 2 default: 0 comments_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/comments/ comment_detail_url_template: type: string example: https://cf-blast.livelikecdn.com/api/v1/comments/{comment_id}/ created_by: type: string example: 460c435b-d3b7-4add-bc63-628b0911f811 created_at: type: string example: '2022-12-21T10:58:46.151911Z' reaction_space_id: type: string example: a0e8a202-0674-4124-b494-f5e32c056dc0 '400': description: '400' content: application/json: examples: Result: value: "{\n \"detail\": \"Comment Board Already exists.\"\n}" schema: type: object properties: detail: type: string example: Comment Board Already exists. tags: - Comment Boards get: summary: Get the list of comment boards description: '' operationId: get-the-list-of-comment-boards parameters: - name: client_id in: query required: true schema: type: string - name: custom_id in: query schema: type: string - name: comment_board_id in: query description: To filter for multiple board ids, use ?comment_board_id=board1&comment_board_id=board2 schema: type: string - in: query name: search schema: type: string description: free text search on comment board title. responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"357d3ffe-f587-4aa7-be2e-67d39d51aa6f\",\n \"url\": \"https://cf-blast.livelikecdn.com/api/v1/comment-boards/357d3ffe-f587-4aa7-be2e-67d39d51aa6f/\",\n \"client_id\": \"lom9db0XtQUhOZQq1vz8QPfSpiyyxppiUVGMcAje\",\n \"custom_id\": \"abbc\",\n \"title\": null,\n \"custom_data\": null,\n \"description\": null,\n \"allow_comments\": true,\n \"replies_depth\": 5,\n \"comments_url\": \"https://cf-blast.livelikecdn.com/api/v1/comments/\",\n \"comment_detail_url_template\": \"https://cf-blast.livelikecdn.com/api/v1/comments/{comment_id}/\",\n \"created_by\": \"aa9daf10-9831-4bda-822c-852ad448cc3c\",\n \"created_at\": \"2022-12-08T09:50:02.429318Z\",\n\t \"reaction_space_id\": \"a0e8a202-0674-4124-b494-f5e32c056dc0\"\n }\n ]\n}" schema: type: object properties: count: type: integer example: 1 default: 0 next: {} previous: {} results: type: array items: type: object properties: id: type: string example: 357d3ffe-f587-4aa7-be2e-67d39d51aa6f url: type: string example: https://cf-blast.livelikecdn.com/api/v1/comment-boards/357d3ffe-f587-4aa7-be2e-67d39d51aa6f/ client_id: type: string example: lom9db0XtQUhOZQq1vz8QPfSpiyyxppiUVGMcAje custom_id: type: string example: abbc title: {} custom_data: {} description: {} allow_comments: type: boolean example: true default: true replies_depth: type: integer example: 5 default: 0 comments_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/comments/ comment_detail_url_template: type: string example: https://cf-blast.livelikecdn.com/api/v1/comments/{comment_id}/ created_by: type: string example: aa9daf10-9831-4bda-822c-852ad448cc3c created_at: type: string example: '2022-12-08T09:50:02.429318Z' reaction_space_id: type: string example: a0e8a202-0674-4124-b494-f5e32c056dc0 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} tags: - Comment Boards /comment-boards/{id}/: patch: summary: Update a comment board description: '' operationId: update-a-comment-board parameters: - name: Authorization in: header description: Bearer Token schema: type: string - in: path name: id schema: type: string required: true description: UUID of the comment board that needs to be updated. requestBody: content: application/json: schema: type: object properties: custom_id: type: string title: type: string description: type: string allow_comments: type: string replies_depth: type: string custom_data: type: string description: 'Custom data is used for things like: Storing extra context for the comment board' content_filter: type: string description: 'To manage the type of comments allowed in a comment board, we provide two levels of content filtering. Each level determines how messages are moderated. **1.** `none`: No content filtering, all users can post freely. **2.**`filtered`: Profanity is automatically filtered.' default: none enum: - none - filtered attributes: type: array description: 'list of comment board attributes in {"key": <>, "value": <>} format' items: properties: {} type: object responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"eefa00d2-cf12-48de-99a0-3f10a1d3587a\",\n \"url\": \"https://cf-blast.livelikecdn.com/api/v1/comment-boards/eefa00d2-cf12-48de-99a0-3f10a1d3587a/\",\n \"client_id\": \"lom9db0XtQUhOZQq1vz8QPfSpiyyxppiUVGMcAje\",\n \"custom_id\": \"a0\",\n \"title\": \"User_Test\",\n \"custom_data\": null,\n \"description\": null,\n \"allow_comments\": true,\n \"replies_depth\": 2,\n \"comments_url\": \"https://cf-blast.livelikecdn.com/api/v1/comments/\",\n \"comment_detail_url_template\": \"https://cf-blast.livelikecdn.com/api/v1/comments/{comment_id}/\",\n \"created_by\": \"460c435b-d3b7-4add-bc63-628b0911f811\",\n \"created_at\": \"2022-12-21T10:58:46.151911Z\",\n \"reaction_space_id\": \"a0e8a202-0674-4124-b494-f5e32c056dc0\"\n}" schema: type: object properties: id: type: string example: eefa00d2-cf12-48de-99a0-3f10a1d3587a url: type: string example: https://cf-blast.livelikecdn.com/api/v1/comment-boards/eefa00d2-cf12-48de-99a0-3f10a1d3587a/ client_id: type: string example: lom9db0XtQUhOZQq1vz8QPfSpiyyxppiUVGMcAje custom_id: type: string example: a0 title: type: string example: User_Test custom_data: {} description: {} allow_comments: type: boolean example: true default: true replies_depth: type: integer example: 2 default: 0 comments_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/comments/ comment_detail_url_template: type: string example: https://cf-blast.livelikecdn.com/api/v1/comments/{comment_id}/ created_by: type: string example: 460c435b-d3b7-4add-bc63-628b0911f811 created_at: type: string example: '2022-12-21T10:58:46.151911Z' reaction_space_id: type: string example: a0e8a202-0674-4124-b494-f5e32c056dc0 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} tags: - Comment Boards x-readme-fauxas: true x-provenance: method: searched source: https://docs.livelike.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://docs.livelike.com/reference/add-bulk-chat-memberships.md - https://docs.livelike.com/reference/add-members-to-group.md - https://docs.livelike.com/reference/add-quest-badges.md - https://docs.livelike.com/reference/award-a-badge-to-a-user.md - https://docs.livelike.com/reference/batch-invoke-reward-action.md - https://docs.livelike.com/reference/claim-user-quest-badges.md - https://docs.livelike.com/reference/claim-user-quest-rewards.md - https://docs.livelike.com/reference/create-a-base-role.md - https://docs.livelike.com/reference/create-a-cheer-meter.md - https://docs.livelike.com/reference/create-a-comment-board.md - https://docs.livelike.com/reference/create-a-comment.md - https://docs.livelike.com/reference/create-a-flair-assignment.md - https://docs.livelike.com/reference/create-a-flair-scope.md - https://docs.livelike.com/reference/create-a-flair.md - https://docs.livelike.com/reference/create-a-group.md - https://docs.livelike.com/reference/create-a-pin-message.md - https://docs.livelike.com/reference/create-a-pinned-comment.md - https://docs.livelike.com/reference/create-a-profile-block.md - https://docs.livelike.com/reference/create-a-profile-relationship.md - https://docs.livelike.com/reference/create-a-program-ban.md - https://docs.livelike.com/reference/create-a-redemption-key.md - https://docs.livelike.com/reference/create-a-registered-link.md - https://docs.livelike.com/reference/create-a-relationship-type.md - https://docs.livelike.com/reference/create-a-rich-post.md - https://docs.livelike.com/reference/create-a-social-embed.md - https://docs.livelike.com/reference/create-a-sticker.md - https://docs.livelike.com/reference/create-a-text-quiz.md - https://docs.livelike.com/reference/create-a-user-reaction.md - https://docs.livelike.com/reference/create-a-user-tier.md - https://docs.livelike.com/reference/create-a-video-alert.md - https://docs.livelike.com/reference/create-an-access-rule-for-muteglobally-mute.md - https://docs.livelike.com/reference/create-an-alert.md - https://docs.livelike.com/reference/create-an-image-number-prediction.md - https://docs.livelike.com/reference/create-an-image-quiz.md - https://docs.livelike.com/reference/create-an-image-slider.md - https://docs.livelike.com/reference/create-badge-1.md - https://docs.livelike.com/reference/create-comment-report.md - https://docs.livelike.com/reference/create-comments-ban.md - https://docs.livelike.com/reference/create-image-number-prediction-follow-up.md - https://docs.livelike.com/reference/create-image-number-prediction-option.md - https://docs.livelike.com/reference/create-image-poll.md - https://docs.livelike.com/reference/create-image-prediction-follow-up.md - https://docs.livelike.com/reference/create-image-prediction-option.md - https://docs.livelike.com/reference/create-poll-vote.md - https://docs.livelike.com/reference/create-profile-by-custom-id.md - https://docs.livelike.com/reference/create-quality-rules.md - https://docs.livelike.com/reference/create-quest-rewards.md - https://docs.livelike.com/reference/create-quests.md - https://docs.livelike.com/reference/create-reaction-emoji.md - https://docs.livelike.com/reference/create-reward-item.md - https://docs.livelike.com/reference/create-reward-table-entry.md - https://docs.livelike.com/reference/create-reward-table.md - https://docs.livelike.com/reference/create-role-assignments.md - https://docs.livelike.com/reference/create-role-grant-assignment.md - https://docs.livelike.com/reference/create-roles.md - https://docs.livelike.com/reference/create-task.md - https://docs.livelike.com/reference/create-text-poll.md - https://docs.livelike.com/reference/create-text-prediction-follow-up.md - https://docs.livelike.com/reference/create-text-prediction-option.md - https://docs.livelike.com/reference/create-tier-benefit.md - https://docs.livelike.com/reference/create-tier-group.md - https://docs.livelike.com/reference/create-tier.md - https://docs.livelike.com/reference/create-user-profile.md - https://docs.livelike.com/reference/create-user-quest.md - https://docs.livelike.com/reference/creating-reward-actions.md - https://docs.livelike.com/reference/credit-reward-item.md - https://docs.livelike.com/reference/debit-reward-item.md - https://docs.livelike.com/reference/delete-a-base-role.md - https://docs.livelike.com/reference/delete-a-comment.md - https://docs.livelike.com/reference/delete-a-flair-assignment.md - https://docs.livelike.com/reference/delete-a-flair.md - https://docs.livelike.com/reference/delete-a-program-ban.md - https://docs.livelike.com/reference/delete-a-redemption-key.md - https://docs.livelike.com/reference/delete-a-registered-link.md - https://docs.livelike.com/reference/delete-a-role.md - https://docs.livelike.com/reference/delete-a-tier-group.md - https://docs.livelike.com/reference/delete-a-user-reaction.md - https://docs.livelike.com/reference/delete-a-video-alert.md - https://docs.livelike.com/reference/delete-bulk-chat-memberships.md - https://docs.livelike.com/reference/delete-comment-board-by-custom-id.md - https://docs.livelike.com/reference/delete-comment-board.md - https://docs.livelike.com/reference/delete-comments-ban.md - https://docs.livelike.com/reference/delete-profile-group.md - https://docs.livelike.com/reference/delete-quest.md - https://docs.livelike.com/reference/delete-reaction-emoji.md - https://docs.livelike.com/reference/delete-reward-table-entry.md - https://docs.livelike.com/reference/delete-reward-table.md - https://docs.livelike.com/reference/delete-role-assignment.md - https://docs.livelike.com/reference/delete-role-grant-unassignment.md - https://docs.livelike.com/reference/delete-task.md - https://docs.livelike.com/reference/delete-tier-benefit.md - https://docs.livelike.com/reference/delete-tier.md - https://docs.livelike.com/reference/delete-userquest.md - https://docs.livelike.com/reference/delete-widget.md - https://docs.livelike.com/reference/dismiss-all-reports-for-a-reported-comment.md - https://docs.livelike.com/reference/flair-assignment-detail.md - https://docs.livelike.com/reference/flair-detail-1.md - https://docs.livelike.com/reference/flair-detail.md - https://docs.livelike.com/reference/get-a-badge.md - https://docs.livelike.com/reference/get-a-redemption-key.md - https://docs.livelike.com/reference/get-a-rich-post.md - https://docs.livelike.com/reference/get-a-social-embed.md - https://docs.livelike.com/reference/get-a-text-ask-widget.md - https://docs.livelike.com/reference/get-a-text-poll.md - https://docs.livelike.com/reference/get-a-text-quiz.md - https://docs.livelike.com/reference/get-a-video-alert.md - https://docs.livelike.com/reference/get-an-alert-1.md - https://docs.livelike.com/reference/get-an-asset-1.md - https://docs.livelike.com/reference/get-an-asset.md - https://docs.livelike.com/reference/get-an-emoji-slider.md - https://docs.livelike.com/reference/get-an-image-poll.md - https://docs.livelike.com/reference/get-an-image-quiz.md - https://docs.livelike.com/reference/get-blocked-profile-ids.md - https://docs.livelike.com/reference/get-blocked-profiles.md - https://docs.livelike.com/reference/get-chatroom-message-count.md - https://docs.livelike.com/reference/get-chatroom-messages.md - https://docs.livelike.com/reference/get-comment-board-by-custom_id.md - https://docs.livelike.com/reference/get-comment-counts.md - https://docs.livelike.com/reference/get-image-number-prediction.md - https://docs.livelike.com/reference/get-leaderboard-by-custom-id.md - https://docs.livelike.com/reference/get-list-of-base-roles.md - https://docs.livelike.com/reference/get-list-of-comment-board-bans.md - https://docs.livelike.com/reference/get-list-of-comment-reports.md - https://docs.livelike.com/reference/get-list-of-earned-badges.md - https://docs.livelike.com/reference/get-list-of-quest-rewards.md - https://docs.livelike.com/reference/get-list-of-resources.md - https://docs.livelike.com/reference/get-pinned-message-info.md - https://docs.livelike.com/reference/get-profile-by-custom-id.md - https://docs.livelike.com/reference/get-profile-group-detail.md - https://docs.livelike.com/reference/get-profile-group-members.md - https://docs.livelike.com/reference/get-program-bans.md - https://docs.livelike.com/reference/get-program-by-custom-id.md - https://docs.livelike.com/reference/get-quest-badges.md - https://docs.livelike.com/reference/get-quests.md - https://docs.livelike.com/reference/get-reaction-space-by-target-group-id.md - https://docs.livelike.com/reference/get-reported-chat-messages.md - https://docs.livelike.com/reference/get-reward-item-balance.md - https://docs.livelike.com/reference/get-reward-table-entry.md - https://docs.livelike.com/reference/get-reward-table.md - https://docs.livelike.com/reference/get-role-templates.md - https://docs.livelike.com/reference/get-roles.md - https://docs.livelike.com/reference/get-task.md - https://docs.livelike.com/reference/get-the-list-of-comment-boards.md - https://docs.livelike.com/reference/get-user-quest-rewards.md - https://docs.livelike.com/reference/get-user-reaction-count-per-space.md - https://docs.livelike.com/reference/get-user-reaction-count.md - https://docs.livelike.com/reference/get-users-badges.md - https://docs.livelike.com/reference/get_reaction-space-by-target-group-id-client-id-target-group-id-1.md - https://docs.livelike.com/reference/invoking-custom-actions.md - https://docs.livelike.com/reference/list-assets.md - https://docs.livelike.com/reference/list-available-badges.md - https://docs.livelike.com/reference/list-badge-progress.md - https://docs.livelike.com/reference/list-comments-by-author.md - https://docs.livelike.com/reference/list-comments.md - https://docs.livelike.com/reference/list-flair-assignments.md - https://docs.livelike.com/reference/list-flairs-1.md - https://docs.livelike.com/reference/list-flairs.md - https://docs.livelike.com/reference/list-invoked-reward-actions.md - https://docs.livelike.com/reference/list-permissions.md - https://docs.livelike.com/reference/list-pinned-comments.md - https://docs.livelike.com/reference/list-profile-relationships.md - https://docs.livelike.com/reference/list-profiles-who-have-earned-a-specific-badge.md - https://docs.livelike.com/reference/list-program-sponsors.md - https://docs.livelike.com/reference/list-quests.md - https://docs.livelike.com/reference/list-reaction-spaces.md - https://docs.livelike.com/reference/list-redemption-keys.md - https://docs.livelike.com/reference/list-registered-links.md - https://docs.livelike.com/reference/list-relationship-types.md - https://docs.livelike.com/reference/list-replies-to-profiles-comments.md - https://docs.livelike.com/reference/list-reward-actions.md - https://docs.livelike.com/reference/list-reward-item-balances.md - https://docs.livelike.com/reference/list-reward-item-transfers.md - https://docs.livelike.com/reference/list-reward-items.md - https://docs.livelike.com/reference/list-reward-tables.md - https://docs.livelike.com/reference/list-reward-transactions.md - https://docs.livelike.com/reference/list-rich-posts-1-1.md - https://docs.livelike.com/reference/list-rich-posts-1.md - https://docs.livelike.com/reference/list-rich-posts.md - https://docs.livelike.com/reference/list-role-assignments.md - https://docs.livelike.com/reference/list-tasks.md - https://docs.livelike.com/reference/list-tier-benefits.md - https://docs.livelike.com/reference/list-tier-groups.md - https://docs.livelike.com/reference/list-tier-transactions.md - https://docs.livelike.com/reference/list-tier.md - https://docs.livelike.com/reference/list-user-quests.md - https://docs.livelike.com/reference/list-user-reactions.md - https://docs.livelike.com/reference/list-user-tiers.md - https://docs.livelike.com/reference/list-widget-reports.md - https://docs.livelike.com/reference/moderate-a-widget-report.md - https://docs.livelike.com/reference/patch-update-a-base-role.md - https://docs.livelike.com/reference/patch-update-a-role-copy.md - https://docs.livelike.com/reference/patch_reaction-space-by-target-group-id-client-id-target-group-id-1-1.md - https://docs.livelike.com/reference/prizeout-user-session.md - https://docs.livelike.com/reference/profile-permissions-check.md - https://docs.livelike.com/reference/publish-widget.md - https://docs.livelike.com/reference/put-update-a-base-role.md - https://docs.livelike.com/reference/remove-a-chatroom-access-rule.md - https://docs.livelike.com/reference/remove-a-quest-reward.md - https://docs.livelike.com/reference/remove-badge-from-quest.md - https://docs.livelike.com/reference/remove-members-from-group.md - https://docs.livelike.com/reference/report-a-widget.md - https://docs.livelike.com/reference/retrieve-a-tier.md - https://docs.livelike.com/reference/retrieve-reward-item.md - https://docs.livelike.com/reference/retrieve-tier-benefit.md - https://docs.livelike.com/reference/revoke-earned-badge.md - https://docs.livelike.com/reference/reward-item-transfers.md - https://docs.livelike.com/reference/role-grant-detail.md - https://docs.livelike.com/reference/role-grants-list.md - https://docs.livelike.com/reference/send-a-widget-chat-message.md - https://docs.livelike.com/reference/send-chat-message.md - https://docs.livelike.com/reference/unassignment-by-natural-key.md - https://docs.livelike.com/reference/unblock-profile-by-profile-custom-id.md - https://docs.livelike.com/reference/unblock-profile.md - https://docs.livelike.com/reference/unpin-a-pinned-comment.md - https://docs.livelike.com/reference/unpin-message.md - https://docs.livelike.com/reference/update-a-comment-board.md - https://docs.livelike.com/reference/update-a-comment.md - https://docs.livelike.com/reference/update-a-flair-1.md - https://docs.livelike.com/reference/update-a-flair-assignment.md - https://docs.livelike.com/reference/update-a-flair.md - https://docs.livelike.com/reference/update-a-redemption-key-by-code.md - https://docs.livelike.com/reference/update-a-redemption-key.md - https://docs.livelike.com/reference/update-a-role.md - https://docs.livelike.com/reference/update-a-video-alert.md - https://docs.livelike.com/reference/update-comment-board-by-custom-id.md - https://docs.livelike.com/reference/update-comment-quality-rules.md - https://docs.livelike.com/reference/update-image-number-prediction-option.md - https://docs.livelike.com/reference/update-image-number-prediction.md - https://docs.livelike.com/reference/update-image-prediction-option.md - https://docs.livelike.com/reference/update-profile-group.md - https://docs.livelike.com/reference/update-reaction-emoji.md - https://docs.livelike.com/reference/update-text-prediction-option.md - https://docs.livelike.com/reference/update-tier-benefit.md - https://docs.livelike.com/reference/update-tier-group.md - https://docs.livelike.com/reference/update-tier.md - https://docs.livelike.com/reference/update-user-quest-task-progress.md - https://docs.livelike.com/reference/update-user-quest.md merge: pages: 237 deduped: 0 conflicts_kept_first: 0