Method: projects.locations.workflows.patch

Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions.

HTTP request

PATCH https://workflows.googleapis.com/v1/{workflow.name=projects/*/locations/*/workflows/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
workflow.name

string

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.

Query parameters

Parameters
updateMask

string (FieldMask format)

List of fields to be updated. If not present, the entire workflow will be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Workflow.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.