Method: sites.versions.patch

Updates the specified metadata for a version. Note that this method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The only valid transition for a version is currently from a CREATED status to a FINALIZED status. Use versions.delete to set the status of a version to DELETED.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The unique identifier for a version, in the format:


This name is provided in the response body when you call the versions.create endpoint.

Query parameters


string (FieldMask format)

A set of field names from your version that you want to update.
A field will be overwritten if, and only if, it's in the mask.
If a mask is not provided then a default mask of only status will be used.

A comma-separated list of fully qualified names of fields. Example: "config,status".

Request body

The request body contains an instance of Version.

Response body

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

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.

Try it!