Skip to content

Update Document Version

Update editable field values on a specific version of a document. See also Update Single Document.

PUT/api/{version}/objects/documents/{doc_id}/versions/{major_version}/{minor_version}
NameDescription
Content-Typeapplication/x-www-form-urlencoded
Acceptapplication/json (default) or application/xml
X-VaultAPI-MigrationModeWhen set to true, Vault relaxes field validation to support document migration. You must have the Document Migration permission to use this header. Learn more about Document Migration Mode.
X-VaultAPI-NoTriggersIf set to true and Document Migration Mode is enabled, it bypasses all system, standard, and custom doctype triggers.

With the X-VaultAPI-MigrationMode header, Vault relaxes field validation to support document migration.

When this header is set to true, Vault:

  • Does not enforce requiredness validation on document fields.
  • Does not enforce Dynamic Reference Constraint (DRC) validation.
  • Does not send notifications.

Additionally, developers can:

  • Manually set the document number.
  • Set lookup field values directly. Vault recalculates a lookup field only when you update one of its source fields.
  • Set created_by__v, document_creation_date__v, last_modified_by__v, and version_modified_date__v.

You must have the Vault Owner Actions: Document Migration permission to use this header. Learn more about Document Migration Mode.

NameDescription
{doc_id}The document id field value.
{major_version}The document major_version_number__v field value.
{minor_version}The document minor_version_number__v field value.

In the body of the request, add any editable field values that you wish to update as name-value pairs. To remove existing field values, include the field name and set its value to null.

To find your Vault’s editable document fields, Retrieve All Document Fields configured on documents. Editable fields will have editable:true.

Object reference fields support object reference notation, which lets you specify a related object record by a unique field value instead of by record ID.

curl -X PUT -H "Authorization: {AUTH_VALUE}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "language__v=English" \
-d "product__v=1357662840171" \
-d "audience__c=consumer__c" \
https://myvault.veevavault.com/api/v26.3/objects/documents/534/versions/2/0
{
    "responseStatus": "SUCCESS",
    "id": 534
}

On SUCCESS, Vault updates field values for the specified version of the document and returns the ID of the updated document.