Skip to content

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.

To delete another user's redaction (redaction__sys) annotation, your security profile must include the Manage Redactions permission. Without it, you can only delete your own redaction annotations.

DELETE/api/{version}/objects/documents/annotations/batch
NameDescription
Content-Typetext/csv or application/json
Acceptapplication/json (default), text/csv, or application/xml

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

NameDescription
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.
curl -X DELETE -H "Authorization: {AUTH_VALUE}" \
-H "Content-Type: text/csv" \
--data-binary @"C:\Vault\Documents\delete_annotations.csv" \
https://myvault.veevavault.com/api/v26.3/objects/documents/annotations/batch
{
   "responseStatus": "SUCCESS",
   "data": [
       {
           "responseStatus": "SUCCESS",
           "document_version_id__sys": "1_0_1",
           "id__sys": "58",
           "global_version_id__sys": "119899_1_1"
       }
   ]
}

On SUCCESS, the response includes the document version ID, global version ID, and ID of each deleted annotation.

Deleting the last redaction annotation on a redaction record that is in the Redacting Source state and has no prior state history automatically deletes the record.