Method: spaces.members.patch

AI-generated Key Takeaways

• This method updates a Google Chat membership, allowing you to modify aspects like user roles within a space.

• It supports both app and user authentication, with an option for administrator privileges using useAdminAccess.

• Requires specifying fields to update with updateMask and includes optional use of administrator privileges.

• You need appropriate OAuth scopes such as chat.app.memberships or chat.admin.memberships for authorization.

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• Try it!

Updates a membership. For an example, see Update a user's membership in a space.

Supports the following types of authentication:

• App authentication with administrator approval and the authorization scope:

  • https://www.googleapis.com/auth/chat.app.memberships (only in spaces the app created)

• User authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.import (import mode spaces only)
  • User authentication grants administrator privileges when an administrator account authenticates, useAdminAccess is true, and the following authorization scope is used:
    • https://www.googleapis.com/auth/chat.admin.memberships

HTTP request

PATCH https://chat.googleapis.com/v1/{membership.name=spaces/*/members/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
membership.name	string Identifier. Resource name of the membership, assigned by the server. Format: spaces/{space}/members/{member}

Query parameters

Parameters
updateMask	string (FieldMask format) Required. The field paths to update. Separate multiple values with commas or use * to update all field paths. Currently supported field paths: role
useAdminAccess	boolean Optional. When true, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires the chat.admin.memberships OAuth 2.0 scope.

Request body

The request body contains an instance of Membership.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/chat.app.memberships
• https://www.googleapis.com/auth/chat.admin.memberships
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.memberships

For more information, see the Authorization guide.