Method: projects.locations.documentSchemas.patch

Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.

HTTP request


Path parameters



Required. The name of the document schema to update. Format: projects/{projectNumber}/locations/{location}/documentSchemas/{document_schema_id}. It takes the form projects/{project}/locations/{location}/documentSchemas/{documentschema}.

Request body

The request body contains data with the following structure:

JSON representation
  "documentSchema": {
    object (DocumentSchema)

object (DocumentSchema)

Required. The document schema to update with.

Response body

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

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.documentSchemas.update

For more information, see the IAM documentation.