**Source URL:** https://limited.veevavault.dev/sitevault/vault-api/api-reference/25.3/documents/document-annotations/update-annotations

# Update Annotations

Update up to 500 existing annotations.

<Endpoint path="/api/{version}/objects/documents/annotations/batch" method="PUT" />

## Headers

<FieldTable>
| Name | Description |
| --- | --- |
| `Accept` | `application/json` (default) or `text/csv` |
| `Content-Type` | `application/json` |
</FieldTable>

## Body Parameters

Prepare a JSON-formatted list of annotation objects. Each object must contain the `id__sys`, `document_version_id__sys`, and the annotation field(s) to be updated. For more details about annotation fields, see [Read Annotations by Document Version and Type](/sitevault/vault-api/api-reference/25.3/documents/document-annotations/read-annotations-by-document-version-and-type).

You can only update an annotation ID (`id__sys`) once per request. If you provide duplicate annotation IDs, the bulk update fails any duplicate annotations.

## Request

<CodeExample title="">
```bash
curl -X PUT -H "Authorization: {SESSION_ID}" \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '[
   {
       "id__sys": "58",
       "document_version_id__sys": "1_0_1",
       "comment__sys": "Updated comment from api"
   },
   {
       "id__sys": "54",
       "document_version_id__sys": "1_0_1",
       "color__sys": "yellow_light__sys"
   }
]'
https://myvault.veevavault.com/api/v24.2/objects/documents/annotations/batch
```
</CodeExample>

## Response

<CodeExample title="">
```json
{
    "responseStatus": "SUCCESS",
    "data": [
        {
            "responseStatus": "SUCCESS",
            "document_version_id__sys": "1_0_1",
            "global_version_id__sys": "123456_1_1",
            "id__sys": "58"
        },
        {
            "responseStatus": "SUCCESS",
            "document_version_id__sys": "1_0_1",
            "global_version_id__sys": "123456_1_1",
            "id__sys": "54"
        }
    ]
}
```
</CodeExample>

## Response Details

On `SUCCESS`, the response includes the document version ID, global version ID, and ID and version of updated annotations. See [Create Annotations](/sitevault/vault-api/api-reference/25.3/documents/document-annotations/create-multiple-annotations) for details. Annotations that did not update successfully are reported with an error message.

---

**Previous:** [Add Annotation Replies](/sitevault/vault-api/api-reference/25.3/documents/document-annotations/add-annotation-replies)  
**Next:** [Read Annotations by Document Version and Type](/sitevault/vault-api/api-reference/25.3/documents/document-annotations/read-annotations-by-document-version-and-type)