Groups Settings API overview
The Groups Settings API updates and retrieves settings for an existingGoogle 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 theCloud Identity documentation.
Groups Settings API data model
The Groups Settings API operates on aGroups resource which represents how userswithin an account communicate and collaborate with groups of other people. Each group is identifiedby the group's email address.
The API data model is based on theGroups collection of the account's groups. Eachgroup 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 followingtable:
| Operation | Description | REST HTTP mappings |
|---|---|---|
get | Gets a group's settings for a customer's account. All get operations must be authorized by anauthenticated user. | GET on a group URI. |
update | Updates a group's settings for a customer's account. All update operations must be authorized by anauthenticated user. | PUT on a group URI. |
JSON and Atom data formats
By default, the Groups Settings API returns data in JSON format. The Atom notation is an alternatedata format. Both the JSON and Atom data formats support full read-write capabilities.
JSON is a commoninternet format that provides a method of representing arbitrary data structures. According tojson.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 thealt query string in your request'sURI—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 theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.