Delete System Comments

​

Delete the entire comment annotation

To add an entire comment annotation via the API, send a POST request to https://us-central1-snipply-sdk-staging.cloudfunctions.net/deleteSystemComment with the following body data.

Body:

{
  "apiKey": "your_api_key_here",
  "authToken": "your_token_here",
  "documentId": "your_document_id_here",
  "annotationId": "COMMENT_ANNOTATION_ID",
}

Response:

{
  "status": "success",
  "message": "System Comment deleted successfully."
}

​

Delete child comment

To delete a specific child comment, you can use the same endpoint except you need to modify your data body to include an commentId field. The annotationId field will contain the parent annotation ID that the child will be removed from.

This will delete the specific child comment inside parent annotation. If there are no more comments available inside comment annotation, then comment annotation will also be deleted.

Body:

{
  "apiKey": "API_KEY",
  "authToken": "AUTH_TOKEN",
  "documentId": "client-document-id",
  "annotationId": "COMMENT_ANNOTATION_ID",
  "commentId": 123456 // child comment id to delete  - can only delete 1 at a time
}

Response:

{
  "status": "success",
  "message": "System Comment thread deleted successfully.",
  "data": {
    "annotationId": "COMMENT_ANNOTATION_ID",
    "commentIds": [ // remaining comment ids
      456789
    ]
  }
}