POST
/
v1
/
commentannotations
/
comments
/
delete

Use this API to delete comments within a specific CommentAnnotation. Additional filters can be applied using comment IDs.

​
Endpoint

POST https://api.velt.dev/v1/commentannotations/comments/delete

​
Headers

x-velt-api-key
string
required

Your API key.

x-velt-auth-token
string
required

Your Auth Token.

​
Body Example

​
Params

data
object
required

​
Example Requests

​
1. Delete all comments of a CommentAnnotation by organizationId, documentId, and annotationId

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "annotationId": "yourAnnotationId"
  }
}

​
2. Delete specific comments of a CommentAnnotation by organizationId, documentId, annotationId and commentIds

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "annotationId": "yourAnnotationId",
    "commentIds": [
      153783,
      607395
    ]
  }
}

​
Response

​
Success Response

{
  "result": {
    "status": "success",
    "message": "Comments(s) deleted successfully.",
    "data": {
      "153783": {
        "success": true,
        "id": 153783,
        "message": "Deleted successfully"
      },
      "607395": {
        "success": false,
        "id": 607395,
        "message": "Not found"
      }
    }
  }
}

​
Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

Was this page helpful?

Update CommentsGet Comments