Outline Wiki icon

Outline Wiki

Interact with the Outline Wiki API — documents, collections, comments, attachments, users, shares

Actions31

Comment → Update

AI-generated

Summary

Update an existing comment in the Outline Wiki by specifying its unique Comment ID and the new comment text in Markdown format.

Inputs

  • Comment ID (required) — The unique UUID of the comment to update.
  • Text (required) — The new body content for the comment, formatted in Markdown.

Output shape

a single JSON object representing the updated comment details from the Outline Wiki API

The operation returns the JSON response from the Outline API's /comments.update endpoint. If the update is successful, the response includes the updated comment data; errors are returned as JSON error messages if any occur.

Examples

Example 1: Update a comment's text

Provide the Comment ID of the comment to update and the new Markdown formatted text content. This will replace the existing comment body with the provided text.

Links

Discussion