DOdovetail
InsightComments

Update insight comment

Changed on

Update a comment on an insight.

Only the comment author can update their own comments.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

Required scope: comment:write

patch/v1/insights/{insight_id}/comments/{comment_id}

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/insights/{insight_id}/comments/{comment_id}
  • Auth
    HTTP bearer

Path parameters

insight_idstring required

Unique identifier of the insight.

comment_idstring required

Unique identifier of the comment.

Request body

bodystring required

The updated comment content. Interpreted according to body_type (defaults to plain text).

body_type'text' | 'html'

Format of the body field. If omitted, defaults to "text". Use "html" for rich text content.

Response

200

Changes

  • 8abea327e6b9Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status