Method: projects.locations.documents.referenceId.patch

Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

HTTP request


Path parameters



Required. The name of the document to update. Format: projects/{projectNumber}/locations/{location}/documents/{documentId} or projects/{projectNumber}/locations/{location}/documents/referenceId/{referenceId}. It takes the form projects/{project}/locations/{location}/documents/referenceId/{referenceid}.

Request body

The request body contains data with the following structure:

JSON representation
  "document": {
    object (Document)
  "requestMetadata": {
    object (RequestMetadata)
  "cloudAiDocumentOption": {
    object (CloudAIDocumentOption)
  "updateOptions": {
    object (UpdateOptions)

object (Document)

Required. The document to update.


object (RequestMetadata)

The meta information collected about the end user, used to enforce access control for the service.


object (CloudAIDocumentOption)

Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.


object (UpdateOptions)

options for the update operation.

Response body

If successful, the response body contains an instance of UpdateDocumentResponse.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • contentwarehouse.documents.update

For more information, see the IAM documentation.