Method: spaces.patch

Updates a space. Requires user authentication and the chat.spaces scope.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
space.name

string

Resource name of the space.

Format: spaces/{space}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The field paths to be updated, comma separated if there are multiple.

Currently supported field paths:

  • displayName (Only supports changing the display name of a space with the SPACE type, or when also including the spaceType mask to change a GROUP_CHAT space type to SPACE. Trying to update the display name of a GROUP_CHAT or a DIRECT_MESSAGE space results in an invalid argument error.)

  • spaceType (Only supports changing a GROUP_CHAT space type to SPACE. Include displayName together with spaceType in the update mask and ensure that the specified space has a non-empty display name and the SPACE space type. Including the spaceType 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).

  • spaceDetails

  • spaceHistoryState (Supports turning history on or off for the space if the organization allows users to change their history setting. Warning: mutually exclusive with all other field paths.)

Request body

The request body contains an instance of Space.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/chat.spaces

For more information, see the Authorization guide.