Every Chat method, from the index.

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 emoji permissions. Requires user authentication with the authorization scope: - https://

No parameters.

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

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. 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

grr chat customEmojis delete --name <name>

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 Manage custom emoji permissions. Requires user authentication with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authori

grr chat customEmojis get --name <name>

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 and Manage custom emoji permissions. Requires user authentication with one of the following [authorization scopes](https://developers.google.com/workspace/chat/aut

grr chat customEmojis list

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

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

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

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 authorization scopes: - https://www.googleapis.com/auth/chat.messages.create - https://www.googleapis.com/auth/chat.messages - https://www.googleapis.com/auth/chat.import (import mode spaces only) You can upload attachme

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

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 authorization scope: - https://www.googleapis.com/auth/chat.import For more information, see Authorize Google Chat apps to import data.

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

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: - App authentication with administrator approval and one of the following authorization scopes: - https://www.googleapis.com/auth/chat.app.spaces.create - https://w

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

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 following types of authentication: - App authentication with administrator approval and the authorization

grr chat spaces delete --name <name>

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, returns the direct message space between the specified user and the calling Chat app. With user authentication, returns the direct message space between the specified user and the authentica

grr chat spaces findDirectMessage

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. If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) membersh

grr chat spaces findGroupChats

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 with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.bot - https://www.googleapis.com/auth/chat.app.spaces with administrator approval - [User authentication

grr chat spaces get --name <name>

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: - App authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot - User authentication wi

grr chat spaces list

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 might already use this display name. Supports the following types of authentication: - App authentication with [administrator approval](https://support.g

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

grr chat spaces search v1/spaces:search

Returns a list of spaces in a Google Workspace organization. For an example, see Search for and manage spaces. When use_admin_access is set to false, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set use_admin_access to true. Supports the following types of authentication: - User authentication with

grr chat spaces search

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 members to add, add memberships with the appropriate membership.member.name. To add a human user, use users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id for the person from the People API, or the id fo

No parameters.

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

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. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of authentication: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app

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

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 with administrator approval and the authorization scope: - https://www.googleapis.com/auth/chat.app.memberships - [User authentication](https://developers.google.com/workspace/

grr chat spaces members delete --name <name>

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: - App authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.bot - https://www.googleapis.com/auth/chat.app.memberships (requires [administrator approval](https://support.goo

grr chat spaces members get --name <name>

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 spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to. Supports

grr chat spaces members list --parent <parent>

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 with administrator approval and the authorization scope: - https://www.googleapis.com/auth/chat.app.memberships (only in spaces the app created) - [User authentication](https://developer

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

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/auth/chat.spaces.pins - https://www.googleapis.com/auth/chat.spaces

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

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/auth/chat.spaces.pins - https://www.googleapis.com/auth/chat.spaces

grr chat spaces messagePins delete --name <name>

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 with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces.pins.readonly - https://www.googleapis.com/auth/chat.spaces.pins - https://www.googleapis.co

grr chat spaces messagePins list --parent <parent>

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. Requires app authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot

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

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 with the authorization scope: - https://www.googleapis.com/auth/chat.bot - User authentication with one of the following authorization scopes: - https://w

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

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 with the authorization scope: - https://www.googleapis.com/auth/chat.bot - User authentication with one of the following authorization scopes: - https://www.googleapis.com/aut

grr chat spaces messages delete --name <name>

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 with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.bot: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash co

grr chat spaces messages get --name <name>

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 interface, the response contains an empty JSON object, {}. For an example, see List messages. Supports the following types of authentication: - [App authentic

grr chat spaces messages list --parent <parent>

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. Supports the following types of authentication: - App authentication with the authorization scope: - https://www.googleapis.com/auth/ch

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

grr chat spaces messages replaceCards v1/{+name}:replaceCards

Replaces the cards included in a message. A Chat app can only replace cards on a human-created message if the message already contains cards, and the cards were created by the app. If the app replaces the cards with an empty list, the cards are removed. After removing the cards, the app cannot add cards back to the message. Requires app authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot

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

grr chat spaces messages search v1/{+parent}/messages:search

Searches for messages in Google Chat that the calling user has access to. Returns a list of messages matching the search criteria. To search across all spaces the user has access to, set parent to spaces/-. Using any other value for parent results in an INVALID_ARGUMENT error. The returned messages have their name field populated with the full resource name, which includes the specific space in which the message resides. This API doesn't return all message types. The types of messages listed below aren't included in the response. Use ListMessages to list all messages. - Private Mes

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

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. Supports the following types of authentication: - App authentication with the authorization scope: - https://www.googleapis.com/auth/ch

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

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 authorization scopes: - https://www.googleapis.com/auth/chat.messages.reactions.create - https://www.googleapis.com/auth/chat.messages.reactions - https://www.googleapis.com/auth/chat.messages - https://www.goog

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

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: - https://www.googleapis.com/auth/chat.messages.reactions - https://www.googleapis.com/auth/chat.messages - https://www.googleapis.com/auth/chat.import (import mode spaces only)

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

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: - https://www.googleapis.com/auth/chat.messages.reactions.readonly - https://www.googleapis.com/auth/chat.messages.reactions - https://www.googleapis.com/auth/chat.messages.readonly - https://www.googleapi

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

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 message but the message was later updated, the server returns the updated Message resource in the event payload. Note: The permissionSettings field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.c

grr chat spaces spaceEvents get --name <name>

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, the server returns Membership resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty Membership resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/auth

grr chat spaces spaceEvents list --parent <parent>

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 with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.availability.readonly - https://www.googleapis.com/auth/chat.us

grr chat users availability get --name <name>

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 expiration. This method only updates the authenticated user's availability. Requires user authentication with authorization scope: - h

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

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 authorization scope: - https://www.googleapis.com/auth/chat.users.availability

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

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 with authorization scope: - https://www.googleapis.com/auth/chat.users.availability

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

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 of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.availability

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

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. Requires user authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections

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

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 authentication with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections

grr chat users sections delete --name <name>

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 with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections - https://www.googleapis.com/auth/chat.users.

grr chat users sections list --parent <parent>

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 with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections

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

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://www.googleapis.com/auth/chat.users.sections

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

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 authorization scope: - https://www.googleapis.com/auth/chat.users.sections - https://www.googleapis.com/auth/chat.users.sections.readonly

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

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 with the authorization scope: - https://www.googleapis.com/auth/chat.users.sections

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

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 with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.readstate.readonly - https://www.googleapis.com/auth/chat.users.readstat

grr chat users spaces getSpaceReadState --name <name>

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 with the authorization scope: - https://www.googleapis.com/auth/chat.users.readstate

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

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 authorization scope: - https://www.googleapis.com/auth/chat.users.spacesettings

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

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 with the authorization scope: - https://www.googleapis.com/auth/chat.users.spacesettings

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

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 with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.readstate.readonly - https://www.googleapis.com/auth/chat.users.reads

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