Groups Settings API overview
Stay organized with collections
Save and categorize content based on your preferences.
The Groups Settings API updates and retrieves settings for an existing
Google Group. Through
the API, you can do the following:
- Modify a group's settings for internal and external group access.
- Edit the group's notifications.
- Configure discussion archiving and message moderation.
- Customize your account's user groups.
For more ways to work with Google Groups, or manage other types of groups, see the
Cloud Identity documentation.
Groups Settings API data model
The Groups Settings API operates on a Groups resource which represents how users
within an account communicate and collaborate with groups of other people. Each group is identified
by the group's email address.
The API data model is based on the Groups collection of the account's groups. Each
group has a unique set of configuration settings.
Groups Settings API operations
You can call group settings methods in the Groups Settings API, as described in the following
table:
| Operation |
Description |
REST HTTP mappings |
get |
Gets a group's settings for a customer's account. All get operations must be authorized by
an
authenticated user. |
GET on a group URI. |
update |
Updates a group's settings for a customer's account. All update operations must be
authorized by an
authenticated user. |
PUT on a group URI. |
By default, the Groups Settings API returns data in JSON format. The Atom notation is an alternate
data format. Both the JSON and Atom data formats support full read-write capabilities.
JSON is a common
internet format that provides a method of representing arbitrary data structures. According to
json.org, JSON is a text format
that is completely language-independent but uses conventions that are familiar to programmers of
the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, and Python.
To change the API's data format, include the alt query string in your request's
URI—for example:
JSON
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json
Atom
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[],[],null,["# Groups Settings API overview\n\nThe Groups Settings API updates and retrieves settings for an existing\n[Google Group](https://support.google.com/a/topic/25838?&ref_topic=9197). Through\nthe API, you can do the following:\n\n- Modify a group's settings for internal and external group access.\n- Edit the group's notifications.\n- Configure discussion archiving and message moderation.\n- Customize your account's user groups.\n\nFor more ways to work with Google Groups, or manage other types of groups, see the\n[Cloud Identity documentation](https://cloud.google.com/identity/docs).\n\n### Groups Settings API data model\n\nThe Groups Settings API operates on a `Groups` resource which represents how users\nwithin an account communicate and collaborate with groups of other people. Each group is identified\nby the group's email address.\n\nThe API data model is based on the `Groups` collection of the account's groups. Each\ngroup has a unique set of configuration settings.\n\n### Groups Settings API operations\n\nYou can call group settings methods in the Groups Settings API, as described in the following\ntable:\n\n| Operation | Description | REST HTTP mappings |\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|\n| `get` | Gets a group's settings for a customer's account. All get operations must be authorized by an [authenticated](/workspace/guides/auth-overview) user. | `GET` on a group URI. |\n| `update` | Updates a group's settings for a customer's account. All update operations must be authorized by an [authenticated](/workspace/guides/auth-overview) user. | `PUT` on a group URI. |\n\nJSON and Atom data formats\n--------------------------\n\nBy default, the Groups Settings API returns data in JSON format. The Atom notation is an alternate\ndata format. Both the JSON and Atom data formats support full read-write capabilities.\n\nJSON is a common\ninternet format that provides a method of representing arbitrary data structures. According to\n[json.org](http://www.json.org), JSON is a text format\nthat is completely language-independent but uses conventions that are familiar to programmers of\nthe C-family of languages, including C, C++, C#, Java, JavaScript, Perl, and Python.\n\n\u003cbr /\u003e\n\nTo change the API's data format, include the `alt` query string in your request's\nURI---for example:\n\n### JSON\n\n```\nGET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json\n```\n\n### Atom\n\n```\nGET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom\n```"]]
