Method: customers.userListQueries.patch

Updates an existing user list query. Partial updates are supported. The following query fields cannot be updated using this method and will be ignored:

  • createTime
  • createEmail
  • updateTime
  • updateEmail

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Name that uniquely identifies a query. It has the form customers/[customerId]/userListQueries/[resource_id], e.g. 'customers/123/userListQueries/abcd1234'. The resource ID is generated by the server.

Query parameters


string (FieldMask format)

Field mask used to support partial updates.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of UserListQuery.

Response body

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

Authorization Scopes

Requires the following OAuth scope: