Update Multiple Document Attachment Descriptions

Update multiple document attachments in bulk with a JSON or CSV input file. This works for version-specific attachments and attachments at the document level. You can only update the latest version of an attachment.

The maximum input file size is 1GB.
The values in the input must be UTF-8 encoded.
CSVs must follow the standard format.
The maximum batch size is 500.

PUT/api/{version}/objects/documents/attachments/batch

Headers

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

Body Parameters

Prepare a CSV or JSON input file.

Name	Description
`id`	The attachment ID to update.
`external_id__v`	Optional: Identify attachments by their external ID instead of regular `id`. You must also add the `idParam=external_id__v` query parameter.
`description__v`	Optional: Description of the attachment. Maximum 1,000 characters.

Request

curl -X PUT -H "Authorization: {SESSION_ID}" \
-H "Content-Type: text/csv" \
-H "Accept: text/csv" \
--data-binary @"C:\Vault\Documents\update_attachments.csv" \
https://myvault.veevavault.com/api/v18.1/objects/documents/attachments/batch

Response

{
    "responseStatus": "SUCCESS",
    "data": [
        {
            "responseStatus": "SUCCESS",
            "id": 38,
            "version": 2
        }
    ]
}

Response Details

On SUCCESS, the response gives the id and version of all successfully updated attachments.