Important: There is a newer version of this product and documentation. You are currently viewing the v1beta1 Recommendations Engine API documentation, which remains available but will no longer be updated.

See Migrating to the Retail API from beta in the new documentation.

Method: projects.locations.catalogs.catalogItems.patch

Stay organized with collections Save and categorize content based on your preferences.

Updates a catalog item. Partial updating is supported. Non-existing items will be created.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id.

Authorization requires the following IAM permission on the specified resource name:

  • automlrecommendations.catalogItems.update

Query parameters


string (FieldMask format)

Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.

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 CatalogItem.

Response body

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

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.