Method: organizations.userGroups.patch

Updates a user group in the specified GMP organization.

HTTP request

PATCH https://marketingplatformadmin.googleapis.com/v1alpha/{userGroup.name=organizations/*/userGroups/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userGroup.name

string

Identifier. Resource name of this UserGroup.

Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match 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 UserGroup.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.update