Method: settings.searchapplications.patch

Updates a search application.

Note: This API requires an admin account to execute.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The name of the Search Application.

Format: searchapplications/{applicationId}.

Query parameters


string (FieldMask format)

Only applies to settings.searchapplications.patch.

Update mask to control which fields to update. Example field paths:, searchApplication.displayName.

  • If updateMask is non-empty, then only the fields specified in the updateMask are updated.
  • If you specify a field in the updateMask, but don't specify its value in the searchApplication, then that field is cleared.
  • If the updateMask is not present or empty or has the value *, then all fields are updated.

Request body

The request body contains an instance of SearchApplication.

Response body

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

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authorization guide.