DEdefaulr
Comments

Update a comment

Changed on

Update a comment, either data or text is required.

post/comments.update

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/comments.update
  • 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 required
dataobject

The body of the comment.

textstring

The body of the comment in markdown.

Example request

{
  "text": "Sounds great"
}

Response

OK

Example response

{
  "data": {
    "createdBy": {
      "name": "Jane Doe"
    },
    "resolvedBy": {
      "name": "Jane Doe",
      "invitedBy": {
        "name": "Jane Doe"
      }
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 71c211078affRevision changes
    • info

      added the new optional request property

    • info

      the request property became optional

  • 9a99ee93e11dRevision changes
    • info

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

    • info

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