Loudvoice API \ Comments \ Delete a comment

Resource/URI - Discussions GET POST PUT DELETE
Discussions /loudvoice/discussions.json List all discussions Create a discussion
Discussion /loudvoice/discussions/<discussion_token>.json Read a discussion Update a discussion Delete a discussion
Discussion messages /loudvoice/comments/<discussion_token>/comments.json Read discussion comments
Resource/URI - Authors GET POST PUT DELETE
Authors /loudvoice/authors.json List all authors Create an author
Author /loudvoice/authors/<author_token>.json Read an author Update an author Delete an author
Resource/URI - Author Sessions GET POST PUT DELETE
Author Sessions /loudvoice/authors/sessions.json List all sessions Create or update a session
Author Session /loudvoice/authors/sessions/<session_token>.json Delete a session
Resource/URI - Comments GET POST PUT DELETE
Comments /loudvoice/comments.json List all comments Create a comment
Comment /loudvoice/comments/<comment_token>.json Read a comment Update a comment Delete a comment
Resource/URI - Votes GET POST PUT DELETE
Votes /loudvoice/votes.json List all
votes
Vote /loudvoice/votes/comments/<comment_token>/authors/<author_token>.json Read a vote Cast a vote Delete a vote

Workflow

Request: the code to send to the API

Send an API request to this endpoint in order to remove an existing comment:

DELETE /loudvoice/comments/<comment_token>.json

The <comment_token> has to be replaced by the unique token of an existing comment. The following URL arguments are supported by this endpoint.

URL argument Description
* confirm_deletion
boolean
To prevent you from unintentionally deleting an entry by mixing up the DELETE/GET methods you must include this parameter and set it's value to true.
delete_sub_comments
boolean
Per default child comments are not deleted but attached to the parent of the removed comment. Set this parameter to true to recursively remove the comment and all child comments.

Result: the code returned by the API

The API will either return a HTTP status code 200 if the entry was successfully deleted or an appropriate message body with further details on the error that occured.

Response Example

{
  "response": {
    "request": {
      "date": "Fri, 08 Nov 2019 10:17:49 +0100",
      "resource": "/loudvoice/comments/2b4c972b-68d0-47d1-ac67-a4f1359a8f31.json?confirm_deletion=true&delete_sub_comments=true",
      "status": {
        "flag": "success",
        "code": 200,
        "info": "The specified comment has successfully been removed"
      }
    }
  }
}

User Contributed Notes