Method: spaces.members.patch
Stay organized with collections
Save and categorize content based on your preferences.
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:
|
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.membershipshttps://www.googleapis.com/auth/chat.admin.membershipshttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.memberships
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-25 UTC.
[null,null,["Last updated 2025-07-25 UTC."],[[["\u003cp\u003eThis method updates a Google Chat membership, allowing you to modify aspects like user roles within a space.\u003c/p\u003e\n"],["\u003cp\u003eIt supports both app and user authentication, with an option for administrator privileges using \u003ccode\u003euseAdminAccess\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRequires specifying fields to update with \u003ccode\u003eupdateMask\u003c/code\u003e and includes optional use of administrator privileges.\u003c/p\u003e\n"],["\u003cp\u003eYou need appropriate OAuth scopes such as \u003ccode\u003echat.app.memberships\u003c/code\u003e or \u003ccode\u003echat.admin.memberships\u003c/code\u003e for authorization.\u003c/p\u003e\n"]]],["This documentation details updating a membership via a `PATCH` HTTP request to `https://chat.googleapis.com/v1/{membership.name=spaces/*/members/*}`. Key actions include setting the `membership.name` path parameter and using the `updateMask` query parameter to specify fields for updating, such as `role`. Optionally, `useAdminAccess` can grant administrator privileges. The request body defines the new membership details, and the response body will contain updated membership information. Multiple authorization scopes are required.\n"],null,["# Method: spaces.members.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members).\n\nSupports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):\n\n- [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope:\n\n - `https://www.googleapis.com/auth/chat.app.memberships` (only in spaces the app created)\n- [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes:\n\n - `https://www.googleapis.com/auth/chat.memberships`\n - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)\n - User authentication grants administrator privileges when an administrator account authenticates, `useAdminAccess` is `true`, and the following authorization scope is used:\n - `https://www.googleapis.com/auth/chat.admin.memberships`\n\n### HTTP request\n\n`PATCH https://chat.googleapis.com/v1/{membership.name=spaces/*/members/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------|\n| `membership.name` | `string` Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}` |\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `role` |\n| `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](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). |\n\n### Request body\n\nThe request body contains an instance of [Membership](/workspace/chat/api/reference/rest/v1/spaces.members#Membership).\n\n### Response body\n\nIf successful, the response body contains an instance of [Membership](/workspace/chat/api/reference/rest/v1/spaces.members#Membership).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.app.memberships`\n- `https://www.googleapis.com/auth/chat.admin.memberships`\n- `https://www.googleapis.com/auth/chat.import`\n- `https://www.googleapis.com/auth/chat.memberships`\n\nFor more information, see the [Authorization guide](/workspace/chat/authenticate-authorize)."]]
