DEdefaulr
Comments

Create a comment

Changed on

Add a comment or reply to a document, either data or text is required. Provide anchorText to create an inline comment attached to a specific text range in the document.

post/comments.create

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/comments.create
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring uuid
documentIdstring uuid required
parentCommentIdstring uuid
dataobject

The body of the comment.

textstring

The body of the comment in markdown.

anchorTextstring

Plain text substring to anchor the comment to as an inline comment. The first occurrence in the document's plain text is used unless disambiguated by anchorPrefix and/or anchorSuffix.

anchorPrefixstring

Text immediately preceding anchorText, used to disambiguate between multiple occurrences. Requires anchorText.

anchorSuffixstring

Text immediately following anchorText, used to disambiguate between multiple occurrences. Requires anchorText.

Example request

{
  "text": "Sounds great"
}

Response

OK

Example response

{
  "data": {
    "createdBy": {
      "name": "Jane Doe"
    },
    "resolvedBy": {
      "name": "Jane Doe",
      "invitedBy": {
        "name": "Jane Doe"
      }
    }
  }
}

Changes

  • cd18cbbc1706Revision changes
    • warning

      the request property's maxLength was set to 10000

  • 9a99ee93e11dRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property ////// to the response with the status