Comments

Delete a comment

Deletes a comment. This action can be undone by setting deleted to False in a comment update request.

Returns

If the request is successful, no content is returned.

If the request is unsuccessful, a JSON object with an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed.

delete/comments/{comment_id}/

Request

  • Base URL
    https://api.test.osf.io/v2
  • URL
    https://api.test.osf.io/v2/comments/{comment_id}/
  • Auth
    none declared

Path parameters

comment_idstring required

The unique identifier of the comment you wish to delete.

Response

No content

Changes

No recorded changes to this operation across all 2 revisions of this API.