Delete Annotations

DELETE https://{{vaultDNS}}/api/{{version}}/objects/documents/annotations/batch

https://developer.veevavault.com/api/24.2/#Delete_Annotations

Delete multiple annotations. You must have Annotate permission on the specified document versions to delete annotations.

Some HTTP clients do not support DELETE requests with a body. As a workaround for these cases, you can simulate this request using the POST method and using the _method=DELETE query parameter.

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

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/v24.2/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"
       }
   ]
}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Acceptstring
Content-Typestring