Use this API to delete comment annotations from a document within an organization. Additional filters can be applied using location IDs, annotation IDs, or user IDs.

Endpoint

POST https://api.velt.dev/v1/commentannotations/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 annotations by organizationId and documentId

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

2. Delete annotations by organizationId, documentId and locationIds

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "locationIds": [
      "locationx"
    ]
  }
}

3. Delete annotations by organizationId, documentId, locationIds and userIds

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "locationIds": [
      "locationx"
    ],
    "userIds": [
      "yourUserId"
    ]
  }
}

4. Delete annotations by organizationId, documentId and userIds

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "userIds": [
      "yourUserId"
    ]
  }
}

5. Delete annotations by organizationId, documentId and annotationIds

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "annotationIds": [
      "yourAnnotationId1",
      "yourAnnotationId2"
    ]
  }
}

6. Delete annotations by organizationId, documentId, locationIds and annotationIds

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "locationIds": [
      "locationx"
    ],
    "annotationIds": [
      "yourAnnotationId1",
      "yourAnnotationId2"
    ]
  }
}

7. Delete annotations by documentId. This will work if the document was created without an organization.

{
  "data": {
    "documentId": "yourDocumentId"
  }
}

8. Delete annotations by documentId and locationIds. This will work if the document was created without an organization.

{
  "data": {
    "documentId": "yourDocumentId",
    "locationIds": [
      "locationx"
    ]
  }
}

9. Delete annotations by documentId and userIds. This will work if the document was created without an organization.

{
  "data": {
    "documentId": "yourDocumentId",
    "userIds": [
      "yourUserId"
    ]
  }
}

10. Delete annotations by documentId and annotationIds. This will work if the document was created without an organization.

{
  "data": {
    "documentId": "yourDocumentId",
    "annotationIds": [
      "yourAnnotationId1",
      "yourAnnotationId2"
    ]
  }
}

11. Delete annotations by documentId, locationIds, and userIds. This will work if the document was created without an organization.

{
  "data": {
    "documentId": "yourDocumentId",
    "locationIds": [
      "locationx"
    ],
    "userIds": [
      "yourUserId"
    ]
  }
}

12. Delete annotations by documentId, locationIds, and annotationIds. This will work if the document was created without an organization.

{
  "data": {
    "documentId": "yourDocumentId",
    "locationIds": [
      "locationx"
    ],
    "annotationIds": [
      "yourAnnotationId1",
      "yourAnnotationId2"
    ]
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Annotations deleted successfully.",
    "data": {
      "yourAnnotationId1": {
        "success": true,
        "id": "yourAnnotationId",
        "message": "Deleted Successfully"
      },
      "yourAnnotationId2": {
        "success": false,
        "id": "yourAnnotationId2",
        "message": "Annotation not found."
      }
    }
  }
}

Failure Response

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

REST APIs

Reference

Delete Comment Annotations

Endpoint

Headers

Body Example

Params

Example Requests

1. Delete annotations by organizationId and documentId

2. Delete annotations by organizationId, documentId and locationIds

3. Delete annotations by organizationId, documentId, locationIds and userIds

4. Delete annotations by organizationId, documentId and userIds

5. Delete annotations by organizationId, documentId and annotationIds

6. Delete annotations by organizationId, documentId, locationIds and annotationIds

7. Delete annotations by documentId. This will work if the document was created without an organization.

8. Delete annotations by documentId and locationIds. This will work if the document was created without an organization.

9. Delete annotations by documentId and userIds. This will work if the document was created without an organization.

10. Delete annotations by documentId and annotationIds. This will work if the document was created without an organization.

11. Delete annotations by documentId, locationIds, and userIds. This will work if the document was created without an organization.

12. Delete annotations by documentId, locationIds, and annotationIds. This will work if the document was created without an organization.

Response

Success Response

Failure Response

REST APIs

Reference

​Endpoint

​Headers

​Body Example

​Params

​Example Requests

​1. Delete annotations by organizationId and documentId

​2. Delete annotations by organizationId, documentId and locationIds

​3. Delete annotations by organizationId, documentId, locationIds and userIds

​4. Delete annotations by organizationId, documentId and userIds

​5. Delete annotations by organizationId, documentId and annotationIds

​6. Delete annotations by organizationId, documentId, locationIds and annotationIds

​7. Delete annotations by documentId. This will work if the document was created without an organization.

​8. Delete annotations by documentId and locationIds. This will work if the document was created without an organization.

​9. Delete annotations by documentId and userIds. This will work if the document was created without an organization.

​10. Delete annotations by documentId and annotationIds. This will work if the document was created without an organization.

​11. Delete annotations by documentId, locationIds, and userIds. This will work if the document was created without an organization.

​12. Delete annotations by documentId, locationIds, and annotationIds. This will work if the document was created without an organization.

​Response

​Success Response

​Failure Response

Endpoint

Headers

Body Example

Params

Example Requests

1. Delete annotations by organizationId and documentId

2. Delete annotations by organizationId, documentId and locationIds

3. Delete annotations by organizationId, documentId, locationIds and userIds

4. Delete annotations by organizationId, documentId and userIds

5. Delete annotations by organizationId, documentId and annotationIds

6. Delete annotations by organizationId, documentId, locationIds and annotationIds

7. Delete annotations by documentId. This will work if the document was created without an organization.

8. Delete annotations by documentId and locationIds. This will work if the document was created without an organization.

9. Delete annotations by documentId and userIds. This will work if the document was created without an organization.

10. Delete annotations by documentId and annotationIds. This will work if the document was created without an organization.

11. Delete annotations by documentId, locationIds, and userIds. This will work if the document was created without an organization.

12. Delete annotations by documentId, locationIds, and annotationIds. This will work if the document was created without an organization.

Response

Success Response

Failure Response