Skip to main content

Comments API

Manage comments on pages.

List Comments

GET /v1/comments

Parameters

ParameterTypeRequiredDescription
pageIdstringYesPage ID
workspaceIdstringYesWorkspace ID

Create Comment

POST /v1/comments

Body Parameters

ParameterTypeRequiredDescription
pageIdstringYesPage ID
workspaceIdstringYesWorkspace ID
textstringYesComment text
parentIdstringNoParent comment for replies

Update Comment

PUT /v1/comments/:commentId


Delete Comment

DELETE /v1/comments/:commentId


Resolve Comment

POST /v1/comments/:commentId/resolve

Body Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
resolvedbooleanYesResolve status