Upload Document Annotations

POST/api/{version}/objects/documents/{doc_id}/annotations

Headers

Name	Description
`Content-Type`	`multipart/form-data`
`Accept`	`application/json` (default) or `application/xml`

File Upload

To upload the file, use the multi-part attachment with the file component "file={file_name}". The maximum allowed file size is 4GB. Vault truncates annotations that exceed the following character limits:

Anchor annotations: Name limited to 140 characters
Note, Link and Anchor annotations: Subject (in Header) limited to 32,000 characters
Note, Link, Line, and Reply annotations: Comment limited to 32,000 characters
External Links: URL Length limited to 32,000 characters

URI Path Parameters

Name	Description
`{doc_id}`	The document `id` field value.

Request

curl -X POST -H "Authorization: {SESSION_ID}" \
-H "Content-Type: multipart/form-data" \
-F "file=document2016.pdf" \
https://myvault.veevavault.com/api/v23.2/objects/documents/548/annotations

Response

{
    "responseStatus": "SUCCESS",
    "responseMessage": "OK",
    "replies": 0,
    "failures": 0,
    "new": 0
}

Response Details

On SUCCESS, Vault uploads the file and its annotations.