Required. Space with fields to be updated. Space.name must be populated in the form of spaces/{space}. Only fields specified by update_mask are updated.
Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: space_details: Updates the space's description. Supports up to 150 characters. display_name: Only supports updating the display name for spaces where spaceType field is SPACE. If you receive the error message ALREADY_EXISTS, try a different value. An existing space within the Google Workspace organization might already use this display name. space_type: Only supports changing a GROUP_CHAT space type to SPACE. Include display_name together with space_type in the update mask and ensure that the specified space has a non-empty display name and the SPACE space type. Including the space_type mask and the SPACE type in the specified space when updating the display name is optional if the existing space already has the SPACE type. Trying to update the space type in other ways results in an invalid argument error. space_type is not supported with useAdminAccess. space_history_state: Updates space history settings by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. space_history_state is not supported with useAdminAccess. access_settings.audience: Updates the access setting of who can discover the space, join the space, and preview the messages in named space where spaceType field is SPACE. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in import mode. To learn more, see Make a space discoverable to specific users. access_settings.audience is not supported with useAdminAccess. permission_settings: Supports changing the permission settings of a space. When updating permission settings, you can only specify permissionSettings field masks; you cannot update other field masks at the same time. permissionSettings is not supported with useAdminAccess. The supported field masks include: - permission_settings.manageMembersAndGroups - permission_settings.modifySpaceDetails - permission_settings.toggleHistory - permission_settings.useAtMentionAll - permission_settings.manageApps - permission_settings.manageWebhooks - permission_settings.replyMessages
↳ use_admin_access
bool
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.spacesOAuth 2.0 scope. Some FieldMask values are not supported using admin access. For details, see the description of update_mask.
getSpace
Required. Space with fields to be updated. Space.name must be
populated in the form of spaces/{space}. Only fields
specified by update_mask are updated.
Required. Space with fields to be updated. Space.name must be
populated in the form of spaces/{space}. Only fields
specified by update_mask are updated.
Required. The updated field paths, comma separated if there are
multiple.
You can update the following fields for a space:
space_details: Updates the space's description. Supports up to 150
characters.
display_name: Only supports updating the display name for spaces where
spaceType field is SPACE.
If you receive the error message ALREADY_EXISTS, try a different
value. An existing space within the
Google Workspace organization might already use this display name.
space_type: Only supports changing a GROUP_CHAT space type to
SPACE. Include display_name together
with space_type in the update mask and ensure that the specified space
has a non-empty display name and the SPACE space type. Including the
space_type mask and the SPACE type in the specified space when updating
the display name is optional if the existing space already has the SPACE
type. Trying to update the space type in other ways results in an invalid
argument error.
space_type is not supported with useAdminAccess.
space_history_state: Updates space history
settings by turning
history on or off for the space. Only supported if history settings are
enabled for the Google Workspace organization. To update the
space history state, you must omit all other field masks in your request.
space_history_state is not supported with useAdminAccess.
access_settings.audience: Updates the access
setting of who can
discover the space, join the space, and preview the messages in named space
where spaceType field is SPACE. If the existing space has a
target audience, you can remove the audience and restrict space access by
omitting a value for this field mask. To update access settings for a
space, the authenticating user must be a space manager and omit all other
field masks in your request. You can't update this field if the space is in
import
mode.
To learn more, see Make a space discoverable to specific
users.
access_settings.audience is not supported with useAdminAccess.
permission_settings: Supports changing the
permission settings
of a space.
When updating permission settings, you can only specify
permissionSettings field masks; you cannot update other field masks
at the same time. permissionSettings is not supported with
useAdminAccess.
The supported field masks include:
Required. The updated field paths, comma separated if there are
multiple.
You can update the following fields for a space:
space_details: Updates the space's description. Supports up to 150
characters.
display_name: Only supports updating the display name for spaces where
spaceType field is SPACE.
If you receive the error message ALREADY_EXISTS, try a different
value. An existing space within the
Google Workspace organization might already use this display name.
space_type: Only supports changing a GROUP_CHAT space type to
SPACE. Include display_name together
with space_type in the update mask and ensure that the specified space
has a non-empty display name and the SPACE space type. Including the
space_type mask and the SPACE type in the specified space when updating
the display name is optional if the existing space already has the SPACE
type. Trying to update the space type in other ways results in an invalid
argument error.
space_type is not supported with useAdminAccess.
space_history_state: Updates space history
settings by turning
history on or off for the space. Only supported if history settings are
enabled for the Google Workspace organization. To update the
space history state, you must omit all other field masks in your request.
space_history_state is not supported with useAdminAccess.
access_settings.audience: Updates the access
setting of who can
discover the space, join the space, and preview the messages in named space
where spaceType field is SPACE. If the existing space has a
target audience, you can remove the audience and restrict space access by
omitting a value for this field mask. To update access settings for a
space, the authenticating user must be a space manager and omit all other
field masks in your request. You can't update this field if the space is in
import
mode.
To learn more, see Make a space discoverable to specific
users.
access_settings.audience is not supported with useAdminAccess.
permission_settings: Supports changing the
permission settings
of a space.
When updating permission settings, you can only specify
permissionSettings field masks; you cannot update other field masks
at the same time. permissionSettings is not supported with
useAdminAccess.
The supported field masks include:
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.spacesOAuth 2.0
scope.
Some FieldMask values are not supported using admin access. For details,
see the description of update_mask.
Returns
Type
Description
bool
setUseAdminAccess
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.spacesOAuth 2.0
scope.
Some FieldMask values are not supported using admin access. For details,
see the description of update_mask.
Required. Space with fields to be updated. Space.name must be
populated in the form of spaces/{space}. Only fields
specified by update_mask are updated.
Required. The updated field paths, comma separated if there are
multiple.
You can update the following fields for a space:
space_details: Updates the space's description. Supports up to 150
characters.
display_name: Only supports updating the display name for spaces where
spaceType field is SPACE.
If you receive the error message ALREADY_EXISTS, try a different
value. An existing space within the
Google Workspace organization might already use this display name.
space_type: Only supports changing a GROUP_CHAT space type to
SPACE. Include display_name together
with space_type in the update mask and ensure that the specified space
has a non-empty display name and the SPACE space type. Including the
space_type mask and the SPACE type in the specified space when updating
the display name is optional if the existing space already has the SPACE
type. Trying to update the space type in other ways results in an invalid
argument error.
space_type is not supported with useAdminAccess.
space_history_state: Updates space history
settings by turning
history on or off for the space. Only supported if history settings are
enabled for the Google Workspace organization. To update the
space history state, you must omit all other field masks in your request.
space_history_state is not supported with useAdminAccess.
access_settings.audience: Updates the access
setting of who can
discover the space, join the space, and preview the messages in named space
where spaceType field is SPACE. If the existing space has a
target audience, you can remove the audience and restrict space access by
omitting a value for this field mask. To update access settings for a
space, the authenticating user must be a space manager and omit all other
field masks in your request. You can't update this field if the space is in
import
mode.
To learn more, see Make a space discoverable to specific
users.
access_settings.audience is not supported with useAdminAccess.
permission_settings: Supports changing the
permission settings
of a space.
When updating permission settings, you can only specify
permissionSettings field masks; you cannot update other field masks
at the same time. permissionSettings is not supported with
useAdminAccess.
The supported field masks include:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Apps Chat V1 Client - Class UpdateSpaceRequest (0.12.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.12.0 (latest)](/php/docs/reference/apps-chat/latest/Chat.V1.UpdateSpaceRequest)\n- [0.11.2](/php/docs/reference/apps-chat/0.11.2/Chat.V1.UpdateSpaceRequest)\n- [0.10.0](/php/docs/reference/apps-chat/0.10.0/Chat.V1.UpdateSpaceRequest)\n- [0.9.0](/php/docs/reference/apps-chat/0.9.0/Chat.V1.UpdateSpaceRequest)\n- [0.8.1](/php/docs/reference/apps-chat/0.8.1/Chat.V1.UpdateSpaceRequest)\n- [0.7.2](/php/docs/reference/apps-chat/0.7.2/Chat.V1.UpdateSpaceRequest)\n- [0.6.1](/php/docs/reference/apps-chat/0.6.1/Chat.V1.UpdateSpaceRequest)\n- [0.5.0](/php/docs/reference/apps-chat/0.5.0/Chat.V1.UpdateSpaceRequest)\n- [0.4.0](/php/docs/reference/apps-chat/0.4.0/Chat.V1.UpdateSpaceRequest)\n- [0.3.0](/php/docs/reference/apps-chat/0.3.0/Chat.V1.UpdateSpaceRequest)\n- [0.2.0](/php/docs/reference/apps-chat/0.2.0/Chat.V1.UpdateSpaceRequest)\n- [0.1.4](/php/docs/reference/apps-chat/0.1.4/Chat.V1.UpdateSpaceRequest) \nReference documentation and code samples for the Google Apps Chat V1 Client class UpdateSpaceRequest.\n\nA request to update a single space.\n\nGenerated from protobuf message `google.chat.v1.UpdateSpaceRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Apps \\\\ Chat \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSpace\n\nRequired. Space with fields to be updated. `Space.name` must be\npopulated in the form of `spaces/{space}`. Only fields\nspecified by `update_mask` are updated.\n\n### hasSpace\n\n### clearSpace\n\n### setSpace\n\nRequired. Space with fields to be updated. `Space.name` must be\npopulated in the form of `spaces/{space}`. Only fields\nspecified by `update_mask` are updated.\n\n### getUpdateMask\n\nRequired. The updated field paths, comma separated if there are\nmultiple.\n\nYou can update the following fields for a space:\n`space_details`: Updates the space's description. Supports up to 150\ncharacters.\n`display_name`: Only supports updating the display name for spaces where\n`spaceType` field is `SPACE`.\nIf you receive the error message `ALREADY_EXISTS`, try a different\nvalue. An existing space within the\nGoogle Workspace organization might already use this display name.\n`space_type`: Only supports changing a `GROUP_CHAT` space type to\n`SPACE`. Include `display_name` together\nwith `space_type` in the update mask and ensure that the specified space\nhas a non-empty display name and the `SPACE` space type. Including the\n`space_type` mask and the `SPACE` type in the specified space when updating\nthe display name is optional if the existing space already has the `SPACE`\ntype. Trying to update the space type in other ways results in an invalid\nargument error.\n`space_type` is not supported with `useAdminAccess`.\n`space_history_state`: Updates [space history\nsettings](https://support.google.com/chat/answer/7664687) by turning\nhistory on or off for the space. Only supported if history settings are\nenabled for the Google Workspace organization. To update the\nspace history state, you must omit all other field masks in your request.\n`space_history_state` is not supported with `useAdminAccess`.\n`access_settings.audience`: Updates the [access\nsetting](https://support.google.com/chat/answer/11971020) of who can\ndiscover the space, join the space, and preview the messages in named space\nwhere `spaceType` field is `SPACE`. If the existing space has a\ntarget audience, you can remove the audience and restrict space access by\nomitting a value for this field mask. To update access settings for a\nspace, the authenticating user must be a space manager and omit all other\nfield masks in your request. You can't update this field if the space is in\n[import\nmode](https://developers.google.com/workspace/chat/import-data-overview).\nTo learn more, see [Make a space discoverable to specific\nusers](https://developers.google.com/workspace/chat/space-target-audience).\n`access_settings.audience` is not supported with `useAdminAccess`.\n`permission_settings`: Supports changing the\n[permission settings](https://support.google.com/chat/answer/13340792)\nof a space.\nWhen updating permission settings, you can only specify\n`permissionSettings` field masks; you cannot update other field masks\nat the same time. `permissionSettings` is not supported with\n`useAdminAccess`.\nThe supported field masks include:\n\n- `permission_settings.manageMembersAndGroups`\n- `permission_settings.modifySpaceDetails`\n- `permission_settings.toggleHistory`\n- `permission_settings.useAtMentionAll`\n- `permission_settings.manageApps`\n- `permission_settings.manageWebhooks`\n- `permission_settings.replyMessages`\n\n### hasUpdateMask\n\n### clearUpdateMask\n\n### setUpdateMask\n\nRequired. The updated field paths, comma separated if there are\nmultiple.\n\nYou can update the following fields for a space:\n`space_details`: Updates the space's description. Supports up to 150\ncharacters.\n`display_name`: Only supports updating the display name for spaces where\n`spaceType` field is `SPACE`.\nIf you receive the error message `ALREADY_EXISTS`, try a different\nvalue. An existing space within the\nGoogle Workspace organization might already use this display name.\n`space_type`: Only supports changing a `GROUP_CHAT` space type to\n`SPACE`. Include `display_name` together\nwith `space_type` in the update mask and ensure that the specified space\nhas a non-empty display name and the `SPACE` space type. Including the\n`space_type` mask and the `SPACE` type in the specified space when updating\nthe display name is optional if the existing space already has the `SPACE`\ntype. Trying to update the space type in other ways results in an invalid\nargument error.\n`space_type` is not supported with `useAdminAccess`.\n`space_history_state`: Updates [space history\nsettings](https://support.google.com/chat/answer/7664687) by turning\nhistory on or off for the space. Only supported if history settings are\nenabled for the Google Workspace organization. To update the\nspace history state, you must omit all other field masks in your request.\n`space_history_state` is not supported with `useAdminAccess`.\n`access_settings.audience`: Updates the [access\nsetting](https://support.google.com/chat/answer/11971020) of who can\ndiscover the space, join the space, and preview the messages in named space\nwhere `spaceType` field is `SPACE`. If the existing space has a\ntarget audience, you can remove the audience and restrict space access by\nomitting a value for this field mask. To update access settings for a\nspace, the authenticating user must be a space manager and omit all other\nfield masks in your request. You can't update this field if the space is in\n[import\nmode](https://developers.google.com/workspace/chat/import-data-overview).\nTo learn more, see [Make a space discoverable to specific\nusers](https://developers.google.com/workspace/chat/space-target-audience).\n`access_settings.audience` is not supported with `useAdminAccess`.\n`permission_settings`: Supports changing the\n[permission settings](https://support.google.com/chat/answer/13340792)\nof a space.\nWhen updating permission settings, you can only specify\n`permissionSettings` field masks; you cannot update other field masks\nat the same time. `permissionSettings` is not supported with\n`useAdminAccess`.\nThe supported field masks include:\n\n- `permission_settings.manageMembersAndGroups`\n- `permission_settings.modifySpaceDetails`\n- `permission_settings.toggleHistory`\n- `permission_settings.useAtMentionAll`\n- `permission_settings.manageApps`\n- `permission_settings.manageWebhooks`\n- `permission_settings.replyMessages`\n\n### getUseAdminAccess\n\nOptional. When `true`, the method runs using the user's Google Workspace\nadministrator privileges.\n\nThe calling user must be a Google Workspace administrator with the\n[manage chat and spaces conversations\nprivilege](https://support.google.com/a/answer/13369245).\nRequires the `chat.admin.spaces` [OAuth 2.0\nscope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).\nSome `FieldMask` values are not supported using admin access. For details,\nsee the description of `update_mask`.\n\n### setUseAdminAccess\n\nOptional. When `true`, the method runs using the user's Google Workspace\nadministrator privileges.\n\nThe calling user must be a Google Workspace administrator with the\n[manage chat and spaces conversations\nprivilege](https://support.google.com/a/answer/13369245).\nRequires the `chat.admin.spaces` [OAuth 2.0\nscope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).\nSome `FieldMask` values are not supported using admin access. For details,\nsee the description of `update_mask`.\n\n### static::build"]]
