grr
api reference · v1

Every Chat method, from the index.

All 54 methods of the Chat API, rendered at build time from the committed Discovery index the grr binary embeds — the same data grr api describe reads at runtime. Flags are kebab-cased parameter names: userId is --user-id.

54 methods · v1 · revision 20260922

chat.customEmojis

4 methods

chat.customEmojis.create

POST

grr chat customEmojis create v1/customEmojis

Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and [Manage custom emoj

No parameters.

https://www.googleapis.com/auth/chat.customemojis least privilege

1 scope
  • https://www.googleapis.com/auth/chat.customemojis

grr chat customEmojis create 
grr chat customEmojis create --body-file ./body.json

chat.customEmojis.delete

DELETE

grr chat customEmojis delete v1/{+name}

Deletes a custom emoji. By default, users can only delete custom emoji they created. Emoji managers assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the custom emoji to delete. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For exam —

https://www.googleapis.com/auth/chat.customemojis least privilege

1 scope
  • https://www.googleapis.com/auth/chat.customemojis

grr chat customEmojis delete 
grr chat customEmojis delete --name <name>

chat.customEmojis.get

GET

grr chat customEmojis get v1/{+name}

Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and [Mana

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the custom emoji. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `cust —

https://www.googleapis.com/auth/chat.customemojis.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

grr chat customEmojis get 
grr chat customEmojis get --name <name>

chat.customEmojis.list

GET

grr chat customEmojis list v1/customEmojis

Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12

Parameter Type Required Repeated Location Description Enum values
filter string — — query Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only `creator("users/me")` and `NOT cre —
pageSize integer — — query Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The —
pageToken string — — query Optional. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When —

https://www.googleapis.com/auth/chat.customemojis.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

grr chat customEmojis list 
grr chat customEmojis list

chat.media

2 methods

chat.media.download

GET

grr chat media download v1/media/{+resourceName}

Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.

Parameter Type Required Repeated Location Description Enum values
resourceName string yes — path Name of the media that is being downloaded. See ReadRequest.resource_name. —

https://www.googleapis.com/auth/chat.messages.readonly least privilege

3 scopes
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

grr chat media download 
grr chat media download --resource-name <resource-name>

chat.media.upload

POST

grr chat media upload v1/{+parent}/attachments:upload

Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication with one of the following [authorizatio

Parameter Type Required Repeated Location Description Enum values
parent string yes — path Required. Resource name of the Chat space in which the attachment is uploaded. Format "spaces/{space}". —

https://www.googleapis.com/auth/chat.messages.create least privilege

3 scopes
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

grr chat media upload 
grr chat media upload --parent <parent> --body-file ./body.json

chat.spaces

10 methods

chat.spaces.completeImport

POST

grr chat spaces completeImport v1/{+name}:completeImport

Completes the import process for the specified space and makes it visible to users. Requires user authentication and domain-wide delegation with the [authoriza

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the import mode space. Format: `spaces/{space}` —

https://www.googleapis.com/auth/chat.import least privilege

1 scope
  • https://www.googleapis.com/auth/chat.import

grr chat spaces completeImport 
grr chat spaces completeImport --name <name> --body-file ./body.json

chat.spaces.create

POST

grr chat spaces create v1/spaces

Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see Create a space. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authori

Parameter Type Required Repeated Location Description Enum values
requestId string — — query Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identica —

https://www.googleapis.com/auth/chat.spaces.create least privilege

5 scopes
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

grr chat spaces create 
grr chat spaces create --body-file ./body.json

chat.spaces.delete

DELETE

grr chat spaces delete v1/{+name}

Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space. Supports the foll

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the space to delete. Format: `spaces/{space}` —
useAdminAccess boolean — — query Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator wit —

https://www.googleapis.com/auth/chat.import least privilege

4 scopes
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.delete
  • https://www.googleapis.com/auth/chat.import

grr chat spaces delete 
grr chat spaces delete --name <name>

chat.spaces.findDirectMessage

GET

grr chat spaces findDirectMessage v1/spaces:findDirectMessage

Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see Find a direct message. With [app authentication](https://developers.google.com/workspace/chat/authe

Parameter Type Required Repeated Location Description Enum values
name string — — query Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.g —

https://www.googleapis.com/auth/chat.spaces.readonly least privilege

3 scopes
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

grr chat spaces findDirectMessage 
grr chat spaces findDirectMessage

chat.spaces.findGroupChats

GET

grr chat spaces findGroupChats v1/spaces:findGroupChats

Returns all spaces with `spaceType == GROUP_CHAT`, whose human memberships contain exactly the calling user, and the users specified in `FindGroupChatsRequest.users`. Only members that have joined the conversation are supported. For an example, see [Find group chats](https://developers.google.com/wo

Parameter Type Required Repeated Location Description Enum values
pageSize integer — — query Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum va —
pageToken string — — query Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other pa —
spaceView string — — query Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY`. Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow rea SPACE_VIEW_UNSPECIFIED · SPACE_VIEW_RESOURCE_NAME_ONLY · SPACE_VIEW_EXPANDED
users string — yes query Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that ca —

https://www.googleapis.com/auth/chat.memberships.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

grr chat spaces findGroupChats 
grr chat spaces findGroupChats

chat.spaces.get

GET

grr chat spaces get v1/{+name}

Returns details about a space. For an example, see Get details about a space. Supports the following types of authentication: - [App authentication](https://developers.go

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}` —
useAdminAccess boolean — — query Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator wit —

https://www.googleapis.com/auth/chat.spaces.readonly least privilege

6 scopes
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

grr chat spaces get 
grr chat spaces get --name <name>

chat.spaces.list

GET

grr chat spaces list v1/spaces

Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authen

Parameter Type Required Repeated Location Description Enum values
filter string — — query Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spac —
pageSize integer — — query Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum v —
pageToken string — — query Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value sho —

https://www.googleapis.com/auth/chat.spaces.readonly least privilege

3 scopes
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

grr chat spaces list 
grr chat spaces list

chat.spaces.patch

PATCH

grr chat spaces patch v1/{+name}

Updates a space. For an example, see Update a space. If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization migh

Parameter Type Required Repeated Location Description Enum values
name string yes — path Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by —
updateMask string — — query 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 —
useAdminAccess boolean — — query Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator wit —

https://www.googleapis.com/auth/chat.spaces least privilege

4 scopes
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

grr chat spaces patch 
grr chat spaces patch --name <name> --body-file ./body.json

chat.spaces.setup

POST

grr chat spaces setup v1/spaces:setup

Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members. To specify the human

No parameters.

https://www.googleapis.com/auth/chat.spaces.create least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

grr chat spaces setup 
grr chat spaces setup --body-file ./body.json

chat.spaces.members

5 methods

chat.spaces.members.create

POST

grr chat spaces members create v1/{+parent}/members

Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining.

Parameter Type Required Repeated Location Description Enum values
parent string yes — path Required. The resource name of the space for which to create the membership. Format: spaces/{space} —
useAdminAccess boolean — — query Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator wit —

https://www.googleapis.com/auth/chat.memberships.app least privilege

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

grr chat spaces members create 
grr chat spaces members create --parent <parent> --body-file ./body.json

chat.spaces.members.delete

DELETE

grr chat spaces members delete v1/{+name}

Deletes a membership. For an example, see Remove a user or a Google Chat app from a space. Supports the following types of authentication: - [App authentication](http

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. —
useAdminAccess boolean — — query Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator wit —

https://www.googleapis.com/auth/chat.memberships.app least privilege

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

grr chat spaces members delete 
grr chat spaces members delete --name <name>

chat.spaces.members.get

GET

grr chat spaces members get v1/{+name}

Returns details about a membership. For an example, see Get details about a user's or Google Chat app's membership. Supports the following types of authentication: - [Ap

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/ch —
useAdminAccess boolean — — query Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator wit —

https://www.googleapis.com/auth/chat.memberships.readonly least privilege

6 scopes
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

grr chat spaces members get 
grr chat spaces members get --name <name>

chat.spaces.members.list

GET

grr chat spaces members list v1/{+parent}/members

Lists memberships in a space. For an example, see List users and Google Chat apps in a space. Listing memberships with app authentication lists memberships in

Parameter Type Required Repeated Location Description Enum values
filter string — — query Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.memb —
pageSize integer — — query Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The —
pageToken string — — query Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other pa —
parent string yes — path Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space} —
showGroups boolean — — query Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memb —
showInvited boolean — — query Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited membersh —
useAdminAccess boolean — — query Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator wit —

https://www.googleapis.com/auth/chat.memberships.readonly least privilege

7 scopes
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

grr chat spaces members list 
grr chat spaces members list --parent <parent>

chat.spaces.members.patch

PATCH

grr chat spaces members patch v1/{+name}

Updates a membership. For an example, see Update a user's membership in a space. Supports the following types of authentication: - [App authentication](https://develo

Parameter Type Required Repeated Location Description Enum values
name string yes — path Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}` —
updateMask string — — query 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 — — query Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator wit —

https://www.googleapis.com/auth/chat.memberships least privilege

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

grr chat spaces members patch 
grr chat spaces members patch --name <name> --body-file ./body.json

chat.spaces.messagePins

3 methods

chat.spaces.messagePins.create

POST

grr chat spaces messagePins create v1/{+parent}/messagePins

Creates a message pin. Requires user authentication with one of the following authorization scopes: - `https://www.googleapis.com/au

Parameter Type Required Repeated Location Description Enum values
parent string yes — path Required. The parent space in which to create the message pin. Format: spaces/{space} —

https://www.googleapis.com/auth/chat.spaces.pins least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.pins

grr chat spaces messagePins create 
grr chat spaces messagePins create --parent <parent> --body-file ./body.json

chat.spaces.messagePins.delete

DELETE

grr chat spaces messagePins delete v1/{+name}

Deletes a message pin. Requires user authentication with one of the following authorization scopes: - `https://www.googleapis.com/au

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin} —

https://www.googleapis.com/auth/chat.spaces.pins least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.pins

grr chat spaces messagePins delete 
grr chat spaces messagePins delete --name <name>

chat.spaces.messagePins.list

GET

grr chat spaces messagePins list v1/{+parent}/messagePins

Lists message pins in a space. Users can pin important messages in spaces for easy access. For more information, see Pin or unpin a conversation in Google Chat. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate

Parameter Type Required Repeated Location Description Enum values
pageSize integer — — query Optional. The maximum number of message pins returned. The service might return fewer messages than this value. The maximum value is 100. If you use a value mor —
pageToken string — — query Optional. A page token received from a previous list message pins call. Provide this parameter to retrieve the subsequent page. When paginating, all other param —
parent string yes — path Required. The parent space which owns the collection of pinned items Format: `spaces/{space}` —

https://www.googleapis.com/auth/chat.spaces.readonly least privilege

4 scopes
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.readonly

grr chat spaces messagePins list 
grr chat spaces messagePins list --parent <parent>

chat.spaces.messages.attachments

1 method

chat.spaces.messages.attachments.get

GET

grr chat spaces messages attachments get v1/{+name}

Gets the metadata of a message attachment. The attachment data is fetched using the media API. For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-att

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`. —

https://www.googleapis.com/auth/chat.bot least privilege

1 scope
  • https://www.googleapis.com/auth/chat.bot

grr chat spaces messages attachments get 
grr chat spaces messages attachments get --name <name>

chat.spaces.messages

7 methods

chat.spaces.messages.create

POST

grr chat spaces messages create v1/{+parent}/messages

Creates a message in a Google Chat space. For an example, see Send a message. Supports the following types of authentication: - [App authentication](https://develope

Parameter Type Required Repeated Location Description Enum values
createMessageNotificationOptions.notificationType string — — query The notification type for the message. NOTIFICATION_TYPE_NONE · NOTIFICATION_TYPE_FORCE_NOTIFY · NOTIFICATION_TYPE_SILENT
messageId string — — query Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource n —
messageReplyOption string — — query Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When [responding to user interactions](https://develope MESSAGE_REPLY_OPTION_UNSPECIFIED · REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD · REPLY_MESSAGE_OR_FAIL
parent string yes — path Required. The resource name of the space in which to create a message. Format: `spaces/{space}` —
requestId string — — query Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identica —
threadKey string — — query Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specif —

https://www.googleapis.com/auth/chat.messages.create least privilege

4 scopes
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

grr chat spaces messages create 
grr chat spaces messages create --parent <parent> --body-file ./body.json

chat.spaces.messages.delete

DELETE

grr chat spaces messages delete v1/{+name}

Deletes a message. For an example, see Delete a message. Supports the following types of authentication: - [App authentication](https://developers.google.com/workspa

Parameter Type Required Repeated Location Description Enum values
force boolean — — query Optional. When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when —
name string yes — path Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the ` —

https://www.googleapis.com/auth/chat.messages least privilege

3 scopes
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

grr chat spaces messages delete 
grr chat spaces messages delete --name <name>

chat.spaces.messages.get

GET

grr chat spaces messages get v1/{+name}

Returns details about a message. For an example, see Get details about a message. Supports the following types of authentication: - [App authentication](https://develop

Parameter Type Required Repeated Location Description Enum values
markupSyntax string — — query Optional. Specifies the desired output syntax for the Chat message `formatted_text` field. MARKUP_SYNTAX_UNSPECIFIED · MARKUP_SYNTAX_CHAT · MARKUP_SYNTAX_MARKDOWN
name string yes — path Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the ` —

https://www.googleapis.com/auth/chat.messages.readonly least privilege

4 scopes
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

grr chat spaces messages get 
grr chat spaces messages get --name <name>

chat.spaces.messages.list

GET

grr chat spaces messages list v1/{+parent}/messages

Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interfa

Parameter Type Required Repeated Location Description Enum values
filter string — — query Optional. A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify —
markupSyntax string — — query Optional. Specifies the desired output syntax for the Chat message `formatted_text` field. MARKUP_SYNTAX_UNSPECIFIED · MARKUP_SYNTAX_CHAT · MARKUP_SYNTAX_MARKDOWN
orderBy string — — query Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for as —
pageSize integer — — query Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum —
pageToken string — — query Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameter —
parent string yes — path Required. The resource name of the space to list messages from. Format: `spaces/{space}` —
showDeleted boolean — — query Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable. —

https://www.googleapis.com/auth/chat.messages.readonly least privilege

4 scopes
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

grr chat spaces messages list 
grr chat spaces messages list --parent <parent>

chat.spaces.messages.patch

PATCH

grr chat spaces messages patch v1/{+name}

Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/updat

Parameter Type Required Repeated Location Description Enum values
allowMissing boolean — — query Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https: —
name string yes — path Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{m —
updateMask string — — query Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `att —

https://www.googleapis.com/auth/chat.messages least privilege

3 scopes
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

grr chat spaces messages patch 
grr chat spaces messages patch --name <name> --body-file ./body.json

chat.spaces.messages.update

PUT

grr chat spaces messages update v1/{+name}

Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/updat

Parameter Type Required Repeated Location Description Enum values
allowMissing boolean — — query Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https: —
name string yes — path Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{m —
updateMask string — — query Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `att —

https://www.googleapis.com/auth/chat.messages least privilege

3 scopes
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

grr chat spaces messages update 
grr chat spaces messages update --name <name> --body-file ./body.json

chat.spaces.messages.reactions

3 methods

chat.spaces.messages.reactions.create

POST

grr chat spaces messages reactions create v1/{+parent}/reactions

Creates a reaction and adds it to a message. For an example, see Add a reaction to a message. Requires user authentication with one of the following [auth

Parameter Type Required Repeated Location Description Enum values
parent string yes — path Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}` —

https://www.googleapis.com/auth/chat.messages.reactions.create least privilege

4 scopes
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

grr chat spaces messages reactions create 
grr chat spaces messages reactions create --parent <parent> --body-file ./body.json

chat.spaces.messages.reactions.delete

DELETE

grr chat spaces messages reactions delete v1/{+name}

Deletes a reaction to a message. For an example, see Delete a reaction. Requires user authentication with one of the following [authorization scopes](http

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}` —

https://www.googleapis.com/auth/chat.messages.reactions least privilege

3 scopes
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

grr chat spaces messages reactions delete 
grr chat spaces messages reactions delete --name <name>

chat.spaces.messages.reactions.list

GET

grr chat spaces messages reactions list v1/{+parent}/reactions

Lists reactions to a message. For an example, see List reactions for a message. Requires user authentication with one of the following [authorization scopes

Parameter Type Required Repeated Location Description Enum values
filter string — — query Optional. A query filter. You can filter reactions by emoji (either `emoji.unicode` —
pageSize integer — — query Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum —
pageToken string — — query Optional. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When pag —
parent string yes — path Required. The message users reacted to. Format: `spaces/{space}/messages/{message}` —

https://www.googleapis.com/auth/chat.messages.readonly least privilege

4 scopes
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.readonly

grr chat spaces messages reactions list 
grr chat spaces messages reactions list --parent <parent>

chat.spaces.spaceEvents

2 methods

chat.spaces.spaceEvents.get

GET

grr chat spaces spaceEvents get v1/{+name}

Returns an event from a Google Chat space. The event payload contains the most recent version of the resource that changed. For example, if you request an event about a new messag

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` —

https://www.googleapis.com/auth/chat.spaces.readonly least privilege

16 scopes
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

grr chat spaces spaceEvents get 
grr chat spaces spaceEvents get --name <name>

chat.spaces.spaceEvents.list

GET

grr chat spaces spaceEvents list v1/{+parent}/spaceEvents

Lists events from a Google Chat space. For each event, the payload contains the most recent version of the Chat resource. For example, if you list events about new space members,

Parameter Type Required Repeated Location Description Enum values
filter string — — query Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` op —
pageSize integer — — query Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error. —
pageToken string — — query Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters pro —
parent string yes — path Required. Resource name of the Google Chat space where the events occurred. Format: —

https://www.googleapis.com/auth/chat.spaces.readonly least privilege

16 scopes
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

grr chat spaces spaceEvents list 
grr chat spaces spaceEvents list --parent <parent>

chat.users.availability

5 methods

chat.users.availability.get

GET

grr chat users availability get v1/{+name}

Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires [user authentication](https://developers.google

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The resource name of the availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK —

https://www.googleapis.com/auth/chat.users.availability.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.users.availability
  • https://www.googleapis.com/auth/chat.users.availability.readonly

grr chat users availability get 
grr chat users availability get --name <name>

chat.users.availability.markAsActive

POST

grr chat users availability markAsActive v1/{+name}:markAsActive

Marks user as `ACTIVE` in Google Chat. Sets the user's availability state to `ACTIVE`. The `ACTIVE` state lasts until the specified expiration, at which point the user's state becomes `AWAY`. Note that if the user is actively using Chat, the `ACTIVE` state duration may extend beyond the provided exp

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The resource name of the availability to mark as active. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admi —

https://www.googleapis.com/auth/chat.users.availability least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.availability

grr chat users availability markAsActive 
grr chat users availability markAsActive --name <name> --body-file ./body.json

chat.users.availability.markAsAway

POST

grr chat users availability markAsAway v1/{+name}:markAsAway

Marks user as `AWAY` in Google Chat. Sets the user's state to away and is not affected by the user's activity. This method only updates the authenticated user's availability. Requires user authentication with [authoriza

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The resource name of the availability to mark as away. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin —

https://www.googleapis.com/auth/chat.users.availability least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.availability

grr chat users availability markAsAway 
grr chat users availability markAsAway --name <name> --body-file ./body.json

chat.users.availability.markAsDoNotDisturb

POST

grr chat users availability markAsDoNotDisturb v1/{+name}:markAsDoNotDisturb

Marks user as `DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication]

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API —

https://www.googleapis.com/auth/chat.users.availability least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.availability

grr chat users availability markAsDoNotDisturb 
grr chat users availability markAsDoNotDisturb --name <name> --body-file ./body.json

chat.users.availability.patch

PATCH

grr chat users availability patch v1/{+name}

Updates availability information for a human user. Only the `custom_status` field can be updated through this method. This method only updates the authenticated user's availability. Requires user authentication with one

Parameter Type Required Repeated Location Description Enum values
name string yes — path Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK direc —
updateMask string — — query Required. The list of fields to update. The only field that can be updated is `custom_status`. —

https://www.googleapis.com/auth/chat.users.availability least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.availability

grr chat users availability patch 
grr chat users availability patch --name <name> --body-file ./body.json

chat.users.sections

5 methods

chat.users.sections.create

POST

grr chat users sections create v1/{+parent}/sections

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/

Parameter Type Required Repeated Location Description Enum values
parent string yes — path Required. The parent resource name where the section is created. Format: `users/{user}` —

https://www.googleapis.com/auth/chat.users.sections least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.sections

grr chat users sections create 
grr chat users sections create --parent <parent> --body-file ./body.json

chat.users.sections.delete

DELETE

grr chat users sections delete v1/{+name}

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. Requires [user authen

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The name of the section to delete. Format: `users/{user}/sections/{section}` —

https://www.googleapis.com/auth/chat.users.sections least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.sections

grr chat users sections delete 
grr chat users sections delete --name <name>

chat.users.sections.list

GET

grr chat users sections list v1/{+parent}/sections

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. Requires [user authentication

Parameter Type Required Repeated Location Description Enum values
pageSize integer — — query 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 maxi —
pageToken string — — query Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provide —
parent string yes — path 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 th —

https://www.googleapis.com/auth/chat.users.sections.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

grr chat users sections list 
grr chat users sections list --parent <parent>

chat.users.sections.patch

PATCH

grr chat users sections patch v1/{+name}

Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see Create and organize sections in Google Chat. Requires user authentication wit

Parameter Type Required Repeated Location Description Enum values
name string yes — path Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-di —
updateMask string — — query Required. The mask to specify which fields to update. Currently supported field paths: - `display_name` —

https://www.googleapis.com/auth/chat.users.sections least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.sections

grr chat users sections patch 
grr chat users sections patch --name <name> --body-file ./body.json

chat.users.sections.position

POST

grr chat users sections position v1/{+name}:position

Changes the sort order of a section. For details, see Create and organize sections in Google Chat. Requires user authentication with the [authorization scope](https://d

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The resource name of the section to position. Format: `users/{user}/sections/{section}` —

https://www.googleapis.com/auth/chat.users.sections least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.sections

grr chat users sections position 
grr chat users sections position --name <name> --body-file ./body.json

chat.users.sections.items

2 methods

chat.users.sections.items.list

GET

grr chat users sections items list v1/{+parent}/items

Lists items in a section. Only spaces can be section items. For details, see Create and organize sections in Google Chat. Requires user authentication with the [authori

Parameter Type Required Repeated Location Description Enum values
filter string — — query Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUM —
pageSize integer — — query 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 —
pageToken string — — query Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters pr —
parent string yes — path 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. W —

https://www.googleapis.com/auth/chat.users.sections.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

grr chat users sections items list 
grr chat users sections items list --parent <parent>

chat.users.sections.items.move

POST

grr chat users sections items move v1/{+name}:move

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. Requires [user authentication](https:

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}` —

https://www.googleapis.com/auth/chat.users.sections least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.sections

grr chat users sections items move 
grr chat users sections items move --name <name> --body-file ./body.json

chat.users.spaces

2 methods

chat.users.spaces.getSpaceReadState

GET

grr chat users spaces getSpaceReadState v1/{+name}

Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see Get details about a user's space read state. Requires [user authentication](https://developers.google.com/work

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the —

https://www.googleapis.com/auth/chat.users.readstate.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

grr chat users spaces getSpaceReadState 
grr chat users spaces getSpaceReadState --name <name>

chat.users.spaces.updateSpaceReadState

PATCH

grr chat users spaces updateSpaceReadState v1/{+name}

Updates a user's read state within a space, used to identify read and unread messages. For an example, see Update a user's space read state. Requires [user authentication](https://developers.google.com/workspace/chat/authenticat

Parameter Type Required Repeated Location Description Enum values
name string yes — path Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState` —
updateMask string — — query Required. The field paths to update. Currently supported field paths: - `last_read_time` When the `last_read_time` is before the latest message create time, the —

https://www.googleapis.com/auth/chat.users.readstate least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.readstate

grr chat users spaces updateSpaceReadState 
grr chat users spaces updateSpaceReadState --name <name> --body-file ./body.json

chat.users.spaces.spaceNotificationSetting

2 methods

chat.users.spaces.spaceNotificationSetting.get

GET

grr chat users spaces spaceNotificationSetting get v1/{+name}

Gets the space notification setting. For an example, see Get the caller's space notification setting. Requires user authentication with the

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces —

https://www.googleapis.com/auth/chat.users.spacesettings least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.spacesettings

grr chat users spaces spaceNotificationSetting get 
grr chat users spaces spaceNotificationSetting get --name <name>

chat.users.spaces.spaceNotificationSetting.patch

PATCH

grr chat users spaces spaceNotificationSetting patch v1/{+name}

Updates the space notification setting. For an example, see Update the caller's space notification setting. Requires user authentication

Parameter Type Required Repeated Location Description Enum values
name string yes — path Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`. —
updateMask string — — query Required. Supported field paths: - `notification_setting` - `mute_setting` —

https://www.googleapis.com/auth/chat.users.spacesettings least privilege

1 scope
  • https://www.googleapis.com/auth/chat.users.spacesettings

grr chat users spaces spaceNotificationSetting patch 
grr chat users spaces spaceNotificationSetting patch --name <name> --body-file ./body.json

chat.users.spaces.threads

1 method

chat.users.spaces.threads.getThreadReadState

GET

grr chat users spaces threads getThreadReadState v1/{+name}

Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see Get details about a user's thread read state. Requires [user authentication](https://developers.google.com/w

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of th —

https://www.googleapis.com/auth/chat.users.readstate.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

grr chat users spaces threads getThreadReadState 
grr chat users spaces threads getThreadReadState --name <name>