Delete Annotations

Delete multiple annotations. The authenticated user must have the appropriate permissions to delete annotations. Learn more about permissions required to delete annotations and delete brought forward annotations in Vault Help.

DELETE/api/{version}/objects/documents/annotations/batch

Headers

Name	Description
`Content-Type`	`text/csv` or `application/json`
`Accept`	`application/json` (default), `text/csv`, or `application/xml`

Body Parameters

Upload parameters as a JSON or CSV file. You can delete up to 500 annotations per batch.

Name	Description
`id__sys` required	The ID of the annotation to delete.
`document_version_id__sys` required	The ID and version number of the document where the annotation appears in the format `{documentId}_{majorVersion}_{minorVersion}`. For example, `138_2_1`.

Request

curl -X DELETE -H "Authorization: {SESSION_ID}" \
-H "Content-Type: text/csv" \
--data-binary @"C:\Vault\Documents\delete_annotations.csv" \
https://myvault.veevavault.com/api/v26.1/objects/documents/annotations/batch

Response

{
   "responseStatus": "SUCCESS",
   "data": [
       {
           "responseStatus": "SUCCESS",
           "document_version_id__sys": "1_0_1",
           "id__sys": "58",
           "global_version_id__sys": "119899_1_1"
       }
   ]
}