This Recommendations AI documentation references the Recommendations console. We recommend switching to the Retail console and using the Retail documentation, which documents Recommendations AI, the Retail console, and Retail Search.

If you are using the v1beta version of Recommendations AI, migrate to the Retail API version.

Method: projects.locations.catalogs.servingConfigs.patch

Updates a ServingConfig.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*

Query parameters


string (FieldMask format)

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

If not set, 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 ServingConfig.

Response body

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

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:

  • retail.servingConfigs.update

For more information, see the IAM documentation.