Method: projects.locations.collections.engines.controls.patch

Updates a Control.

Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*

Query parameters


string (FieldMask format)

Optional. Indicates which fields in the provided Control to update. The following are NOT supported:

If not set or empty, all supported fields are 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 Control.

Response body

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

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:

  • discoveryengine.controls.update

For more information, see the IAM documentation.