Method: projects.locations.catalogs.patch

Updates the Catalogs.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Immutable. The fully qualified resource name of the catalog.

Query parameters


string (FieldMask format)

Indicates which fields in the provided Catalog to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

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

Response body

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

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.catalogs.update

For more information, see the IAM documentation.