Board API

The Board API helps you manage boards, posts, and comments.

To use the Board API, you need an access token that you can get by authenticating with a user account or a service account. The API scopes are board and board.read.

Manage boards {#manage-board}

You can manage boards using the following API operations.

While you can set the category, order, permission, and type of a board, the Board API helps you manage only the title (boardName) and description (description) of a board.

{   "boardName": "Board title",   "description": "Board description"}

Manage posts {#manage-post}

Add a post to a board. You can manage posts using the following API operations. Specify a board ID (boardID) when making an API call.

You can get specific posts from boards.

Add a post by specifying its title and body. You can include HTML tags in the body. You can also specify whether to use comments (enableComment), whether to send notifications for creating posts (sendNotifications), and the must-read end date (mustReadEndDate).

{   "title": "Post title",   "body": "<h1>Post</h1> Body",   "enableComment": true,   "sendNotifications": true,   "mustReadEndDate": "2023-07-20"}

Manage attachments {#manage-post-attachment}

You can attach multiple files to a post.

For how to get attachments, see Upload or Download Files.

Manage comments {#manage-comment}

You can comment on posts. Use the following API operations to manage comments. Specify a board ID (boardId) and a post ID (postId) when making an API call.

Add a comment by specifying content.

{   "content": "This is a comment"}

Manage comment attachments {#manage-comment-attachment}

You can attach multiple files to a comment.

For how to add and get attachments, see Upload or Download Files.