Google Chat API (chat:v1)

2026-03-25

7 new methods

Additions

    Methods
  • chat.users.sections.create

      Path : v1/{+parent}/sections

      Flat Path : v1/users/{usersId}/sections

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent resource name where the section is created. Format: `users/{user}`

          Pattern : ^users/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/chat.users.sections

      Description : [Developer Preview](https://developers.google.com/workspace/preview): Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

  • chat.users.sections.delete

      Path : v1/{+name}

      Flat Path : v1/users/{usersId}/sections/{sectionsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the section to delete. Format: `users/{user}/sections/{section}`

          Pattern : ^users/[^/]+/sections/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/chat.users.sections

      Description : [Developer Preview](https://developers.google.com/workspace/preview): Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

  • chat.users.sections.patch

      Path : v1/{+name}

      Flat Path : v1/users/{usersId}/sections/{sectionsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`

          Pattern : ^users/[^/]+/sections/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Required. The mask to specify which fields to update. Currently supported field paths: - `display_name`

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/chat.users.sections

      Description : [Developer Preview](https://developers.google.com/workspace/preview): Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

  • chat.users.sections.list

      Path : v1/{+parent}/sections

      Flat Path : v1/users/{usersId}/sections

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}`

          Pattern : ^users/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. The maximum number of sections to return. The service may return fewer than this value. If unspecified, at most 10 sections will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

          Location : query

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/chat.users.sections
    • https://www.googleapis.com/auth/chat.users.sections.readonly
    • Description : [Developer Preview](https://developers.google.com/workspace/preview): Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`

  • chat.users.sections.position

      Path : v1/{+name}:position

      Flat Path : v1/users/{usersId}/sections/{sectionsId}:position

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of the section to position. Format: `users/{user}/sections/{section}`

          Pattern : ^users/[^/]+/sections/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/chat.users.sections

      Description : [Developer Preview](https://developers.google.com/workspace/preview): Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

  • chat.users.sections.items.list

      Path : v1/{+parent}/items

      Flat Path : v1/users/{usersId}/sections/{sectionsId}/items

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}`

          Pattern : ^users/[^/]+/sections/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

          Location : query

          Type : string

        filter

          Description : Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUMENT` error.

          Location : query

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/chat.users.sections
    • https://www.googleapis.com/auth/chat.users.sections.readonly
    • Description : [Developer Preview](https://developers.google.com/workspace/preview): Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`

  • chat.users.sections.items.move

      Path : v1/{+name}:move

      Flat Path : v1/users/{usersId}/sections/{sectionsId}/items/{itemsId}:move

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}`

          Pattern : ^users/[^/]+/sections/[^/]+/items/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/chat.users.sections

      Description : [Developer Preview](https://developers.google.com/workspace/preview): Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`