A Groups resource is the root data class for the Groups Settings API. Each Groups resource is associated with a collection of settings.
For more information, see a list of methods for this resource.
Resource representations
A Groups resource includes metadata with a summary of a specified group's settings. These settings manage the group's access, notifications, discussion archiving, message moderation, and customize your account's user groups.
By default, the Groups resource data is returned in the atom+XML data format.
Atom
< entry xmlns = "http://www.w3.org/2005/Atom" xmlns : apps = "http://schemas.google.com/apps/2006" xmlns : gd = "http://schemas.google.com/g/2005" > < id > string < / id > < title > Groups Resource Entry < / title > < content type = "text" > string < / content > < author > < name > Google < / name > < / author > < apps : email > string < / apps : email > < apps : name > string < / apps : name > < apps : description > string < / apps : description > < apps : whoCanJoin > string < / apps : whoCanJoin > < apps : whoCanViewMembership > string < / apps : whoCanViewMembership > < apps : whoCanViewGroup > string < / apps : whoCanViewGroup > < apps : whoCanInvite > string < / apps : whoCanInvite > < apps : whoCanAdd > string < / apps : whoCanAdd > < apps : allowExternalMembers > string < / apps : allowExternalMembers > < apps : whoCanPostMessage > string < / apps : whoCanPostMessage > < apps : allowWebPosting > string < / apps : allowWebPosting > < apps : primaryLanguage > string < / apps : primaryLanguage > < apps : maxMessageBytes > integer < / apps : maxMessageBytes > < apps : isArchived > string < / apps : isArchived > < apps : archiveOnly > string < / apps : archiveOnly > < apps : messageModerationLevel > string < / apps : messageModerationLevel > < apps : spamModerationLevel > string < / apps : spamModerationLevel > < apps : replyTo > string < / apps : replyTo > < apps : customReplyTo > string < / apps : customReplyTo > < apps : includeCustomFooter > string < / apps : includeCustomFooter > < apps : customFooterText > string < / apps : customFooterText > < apps : sendMessageDenyNotification > string < / apps : sendMessageDenyNotification > < apps : defaultMessageDenyNotificationText > string < / apps : defaultMessageDenyNotificationText > < apps : showInGroupDirectory > string < / apps : showInGroupDirectory > < apps : allowGoogleCommunication > string < / apps : allowGoogleCommunication > < apps : membersCanPostAsTheGroup > string < / apps : membersCanPostAsTheGroup > < apps : messageDisplayFont > string < / apps : messageDisplayFont > < apps : includeInGlobalAddressList > string < / apps : includeInGlobalAddressList > < apps : whoCanLeaveGroup > string < / apps : whoCanLeaveGroup > < apps : whoCanContactOwner > string < / apps : whoCanContactOwner > < apps : whoCanAddReferences > string < / apps : whoCanAddReferences > < apps : whoCanAssignTopics > string < / apps : whoCanAssignTopics > < apps : whoCanUnassignTopic > string < / apps : whoCanUnassignTopic > < apps : whoCanTakeTopics > string < / apps : whoCanTakeTopics > < apps : whoCanMarkDuplicate > string < / apps : whoCanMarkDuplicate > < apps : whoCanMarkNoResponseNeeded > string < / apps : whoCanMarkNoResponseNeeded > < apps : whoCanMarkFavoriteReplyOnAnyTopic > string < / apps : whoCanMarkFavoriteReplyOnAnyTopic > < apps : whoCanMarkFavoriteReplyOnOwnTopic > string < / apps : whoCanMarkFavoriteReplyOnOwnTopic > < apps : whoCanUnmarkFavoriteReplyOnAnyTopic > string < / apps : whoCanUnmarkFavoriteReplyOnAnyTopic > < apps : whoCanEnterFreeFormTags > string < / apps : whoCanEnterFreeFormTags > < apps : whoCanModifyTagsAndCategories > string < / apps : whoCanModifyTagsAndCategories > < apps : favoriteRepliesOnTop > string < / apps : favoriteRepliesOnTop > < apps : whoCanApproveMembers > string < / apps : whoCanApproveMembers > < apps : whoCanBanUsers > string < / apps : whoCanBanUsers > < apps : whoCanModifyMembers > string < / apps : whoCanModifyMembers > < apps : whoCanApproveMessages > string < / apps : whoCanApproveMessages > < apps : whoCanDeleteAnyPost > string < / apps : whoCanDeleteAnyPost > < apps : whoCanDeleteTopics > string < / apps : whoCanDeleteTopics > < apps : whoCanLockTopics > string < / apps : whoCanLockTopics > < apps : whoCanMoveTopicsIn > string < / apps : whoCanMoveTopicsIn > < apps : whoCanMoveTopicsOut > string < / apps : whoCanMoveTopicsOut > < apps : whoCanPostAnnouncements > string < / apps : whoCanPostAnnouncements > < apps : whoCanHideAbuse > string < / apps : whoCanHideAbuse > < apps : whoCanMakeTopicsSticky > string < / apps : whoCanMakeTopicsSticky > < apps : whoCanModerateMembers > string < / apps : whoCanModerateMembers > < apps : whoCanModerateContent > string < / apps : whoCanModerateContent > < apps : whoCanAssistContent > string < / apps : whoCanAssistContent > < apps : customRolesEnabledForSettingsToBeMerged > string < / apps : customRolesEnabledForSettingsToBeMerged > < apps : enableCollaborativeInbox > string < / apps : enableCollaborativeInbox > < apps : whoCanDiscoverGroup > string < / apps : whoCanDiscoverGroup > < apps : defaultSender > string < / apps : defaultSender > < / entry >
The following table shows the Groups resources:
entry
object
entry/
xmlns
string
entry/
xmlns:apps
string
entry/
xmlns:gd
string
entry/
id
object
entry/
title
object
Groups Resource Entry
entry/
content
object
entry/content/
type
string
text
entry/
apps:email
object
The group's email address. This property can be updated using the Directory API .
entry/
apps:name
object
entry/
apps:description
object
entry/
apps:whoCanJoin
object
-
ANYONE_CAN_JOIN
: Any internet user, both inside and outside your domain, can join the group. -
ALL_IN_DOMAIN_CAN_JOIN
: Anyone in the account domain can join. This includes accounts with multiple domains. -
INVITED_CAN_JOIN
: Candidates for membership can be invited to join. -
CAN_REQUEST_TO_JOIN
: Non members can request an invitation to join.
entry/
apps:whoCanViewMembership
object
-
ALL_IN_DOMAIN_CAN_VIEW
: Anyone in the account can view the group members list.If a group already has external members, those members can still send email to this group.
-
ALL_MEMBERS_CAN_VIEW
: The group members can view the group members list. -
ALL_MANAGERS_CAN_VIEW
: The group managers can view group members list.
entry/
apps:whoCanViewGroup
object
-
ANYONE_CAN_VIEW
: Any internet user can view the group's messages. -
ALL_IN_DOMAIN_CAN_VIEW
: Anyone in your account can view this group's messages. -
ALL_MEMBERS_CAN_VIEW
: All group members can view the group's messages. -
ALL_MANAGERS_CAN_VIEW
: Any group manager can view this group's messages. -
ALL_OWNERS_CAN_VIEW
: Any group owner can view this group's messages.
entry/
apps:whoCanInvite
object
whoCanModerateMembers
setting. Permissions to invite new members. Possible values are: -
ALL_MEMBERS_CAN_INVITE
: Managers and members can invite a new member candidate. -
ALL_MANAGERS_CAN_INVITE
: Only managers can invite a new member. This includes the group's owner. -
ALL_OWNERS_CAN_INVITE
: Only owners can invite a new member. -
NONE_CAN_INVITE
: No one can invite a new member candidate.
entry/
apps:whoCanAdd
object
whoCanModerateMembers
setting. Permissions to directly add new members. Possible values are: -
ALL_MEMBERS_CAN_ADD
: Managers and members can directly add new members. -
ALL_MANAGERS_CAN_ADD
: Only managers can directly add new members. This includes the group's owner. -
ALL_OWNERS_CAN_ADD
: Only owners can directly add new members. -
NONE_CAN_ADD
: No one can directly add new members.
entry/
apps:allowExternalMembers
object
-
true
: Google Workspace users external to your organization can become members of this group. -
false
: Users not belonging to the organization are not allowed to become members of this group.
entry/
apps:whoCanPostMessage
object
-
NONE_CAN_POST
: The group is disabled and archived. No one can post a message to this group.- When archiveOnly is
false
, updatingwhoCanPostMessage
toNONE_CAN_POST
, results in an error. - If archiveOnly is reverted from
true
tofalse
,whoCanPostMessages
is set toALL_MANAGERS_CAN_POST
.
- When archiveOnly is
-
ALL_MANAGERS_CAN_POST
: Managers, including group owners, can post messages. -
ALL_MEMBERS_CAN_POST
: Any group member can post a message. -
ALL_OWNERS_CAN_POST
: Only group owners can post a message. -
ALL_IN_DOMAIN_CAN_POST
: Anyone in the account can post a message. -
ANYONE_CAN_POST
: Any internet user who outside your account can access your Google Groups service and post a message.
entry/
apps:allowWebPosting
object
-
true
: Allows any member to post to the group forum. -
false
: Members only use Gmail to communicate with the group.
entry/
apps:primaryLanguage
object
entry/
apps:maxMessageBytes
object
entry/
apps:isArchived
object
-
true
: Archive messages sent to the group. -
false
: Do not keep an archive of messages sent to this group. Iffalse
, previously archived messages remain in the archive.
entry/
apps:archiveOnly
object
-
true
: Group is archived and the group is inactive. New messages to this group are rejected. The older archived messages are browseable and searchable.- If
true
, thewhoCanPostMessage
property is set toNONE_CAN_POST
. - If reverted from
true
tofalse
, whoCanPostMessages is set toALL_MANAGERS_CAN_POST
.
- If
-
false
: The group is active and can receive messages.- When
false
, updatingwhoCanPostMessage
toNONE_CAN_POST
, results in an error.
- When
entry/
apps:spamModerationLevel
object
-
ALLOW
: Post the message to the group. -
MODERATE
: Send the message to the moderation queue. This is the default. -
SILENTLY_MODERATE
: Send the message to the moderation queue, but do not send notification to moderators. -
REJECT
: Immediately reject the message.
entry/
apps:replyTo
object
-
REPLY_TO_CUSTOM
: For replies to messages, use the group's custom email address.When the group's
ReplyTo
property is set toREPLY_TO_CUSTOM
, thecustomReplyTo
property holds the custom email address used when replying to a message. If the group'sReplyTo
property is set toREPLY_TO_CUSTOM
, thecustomReplyTo
property must have a value. Otherwise an error is returned. -
REPLY_TO_SENDER
: The reply sent to author of message. -
REPLY_TO_LIST
: This reply message is sent to the group. -
REPLY_TO_OWNER
: The reply is sent to the owners of the group. This doesn't include the group's managers. -
REPLY_TO_IGNORE
: Group users individually decide where the message reply is sent. -
REPLY_TO_MANAGERS
: This reply message is sent to the group's managers, which includes all managers and the group owner.
entry/
apps:customReplyTo
object
replyTo
property is set to REPLY_TO_CUSTOM
. This address is defined by an account administrator. - When the group's
ReplyTo
property is set toREPLY_TO_CUSTOM
, thecustomReplyTo
property holds a custom email address used when replying to a message. - If the group's
ReplyTo
property is set toREPLY_TO_CUSTOM
, thecustomReplyTo
property must have a text value or an error is returned.
entry/
apps:sendMessageDenyNotification
object
-
true
: When a message is rejected, send the deny message notification to the message author.The
defaultMessageDenyNotificationText
property is dependent on thesendMessageDenyNotification
property beingtrue
. -
false
: When a message is rejected, no notification is sent.
entry/
apps:defaultMessageDenyNotificationText
object
entry/
apps:showInGroupDirectory
object
whoCanDiscoverGroup
setting. Allows the group to be visible in the Groups Directory. Possible values are: -
true
: All groups in the account are listed in the Groups directory. -
false
: All groups in the account are not listed in the directory.
entry/
apps:allowGoogleCommunication
object
-
true
: Allow Google to contact managers of this group. Occasionally Google may send updates on the latest features, ask for input on new features, or ask for permission to highlight your group. -
false
: Google can not contact managers of this group.
entry/
apps:membersCanPostAsTheGroup
object
-
true
: Group member can post messages using the group's email address instead of their own email address. Message appear to originate from the group itself. -
false
: Members can not post in behalf of the group's email address.
entry/
apps:includeInGlobalAddressList
object
-
true
: Group is included in the Global Address List. -
false
: Group is not included in the Global Address List.
entry/
apps:whoCanLeaveGroup
object
-
ALL_MANAGERS_CAN_LEAVE
-
ALL_MEMBERS_CAN_LEAVE
-
NONE_CAN_LEAVE
entry/
apps:whoCanContactOwner
object
-
ALL_IN_DOMAIN_CAN_CONTACT
-
ALL_MANAGERS_CAN_CONTACT
-
ALL_MEMBERS_CAN_CONTACT
-
ANYONE_CAN_CONTACT
entry/
apps:whoCanAddReferences
object
NONE
. entry/
apps:whoCanAssignTopics
object
whoCanAssistContent
setting. Specifies who can assign topics in a forum to another user. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanUnassignTopic
object
whoCanAssistContent
setting. Specifies who can unassign any topic in a forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanTakeTopics
object
whoCanAssistContent
setting. Specifies who can take topics in a forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanMarkDuplicate
object
whoCanAssistContent
setting. Specifies who can mark a topic as a duplicate of another topic. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanMarkNoResponseNeeded
object
whoCanAssistContent
setting. Specifies who can mark a topic as not needing a response. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanMarkFavoriteReplyOnAnyTopic
object
whoCanAssistContent
setting. Specifies who can mark any other user’s post as a favorite reply. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanMarkFavoriteReplyOnOwnTopic
object
whoCanAssistContent
setting. Specifies who can mark a post for a topic they started as a favorite reply. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanUnmarkFavoriteReplyOnAnyTopic
object
whoCanAssistContent
setting. Specifies who can un-mark any post from a favorite reply. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanEnterFreeFormTags
object
whoCanAssistContent
setting. Specifies who can enter free form tags for topics in a forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanModifyTagsAndCategories
object
whoCanAssistContent
setting. Specifies who can change tags and categories. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:favoriteRepliesOnTop
object
-
true
: Favorite replies will be displayed above other replies. -
false
: Favorite replies will not be displayed above other replies.
entry/
apps:whoCanApproveMembers
object
whoCanModerateMembers
setting. Deprecated. This is merged into the whoCanModerateMembers
setting. Specifies who can approve members who ask to join groups. Possible values are: -
ALL_MEMBERS_CAN_APPROVE
-
ALL_MANAGERS_CAN_APPROVE
-
ALL_OWNERS_CAN_APPROVE
-
NONE_CAN_APPROVE
entry/
apps:whoCanBanUsers
object
whoCanModerateMembers
setting. Specifies who can deny membership to users. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanModifyMembers
object
whoCanModerateMembers
setting. Specifies who can change group members' roles. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanApproveMessages
object
whoCanModerateContent
setting. Specifies who can approve pending messages in the moderation queue. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanDeleteAnyPost
object
whoCanModerateContent
setting. Specifies who can delete replies to topics. (Authors can always delete their own posts). Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanDeleteTopics
object
whoCanModerateContent
setting. Specifies who can delete topics. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanLockTopics
object
whoCanModerateContent
setting. Specifies who can prevent users from posting replies to topics. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanMoveTopicsIn
object
whoCanModerateContent
setting. Specifies who can move topics into the group or forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanMoveTopicsOut
object
whoCanModerateContent
setting. Specifies who can move topics out of the group or forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanPostAnnouncements
object
whoCanModerateContent
setting. Specifies who can post announcements, a special topic type. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanHideAbuse
object
whoCanModerateContent
setting. Specifies who can hide posts by reporting them as abuse. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanMakeTopicsSticky
object
whoCanModerateContent
setting. Specifies who can make topics appear at the top of the topic list. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanModerateMembers
object
-
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanModerateContent
object
-
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
entry/
apps:whoCanAssistContent
object
-
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
entry/
apps:customRolesEnabledForSettingsToBeMerged
object
UPDATE
and PATCH
requests to it are ignored. Possible values are: -
true
-
false
entry/
apps:enableCollaborativeInbox
object
-
true
-
false
entry/
apps:whoCanDiscoverGroup
object
-
ANYONE_CAN_DISCOVER
-
ALL_IN_DOMAIN_CAN_DISCOVER
-
ALL_MEMBERS_CAN_DISCOVER
entry/
apps:defaultSender
object
-
DEFAULT_SELF
-
GROUP
JSON
{ "kind" : "groupsSettings#groups" , "email" : string , "name" : string , "description" : string , "whoCanJoin" : string , "whoCanViewMembership" : string , "whoCanViewGroup" : string , "whoCanInvite" : string , "whoCanAdd" : string , "allowExternalMembers" : string , "whoCanPostMessage" : string , "allowWebPosting" : string , "primaryLanguage" : string , "maxMessageBytes" : integer , "isArchived" : string , "archiveOnly" : string , "messageModerationLevel" : string , "spamModerationLevel" : string , "replyTo" : string , "customReplyTo" : string , "includeCustomFooter" : string , "customFooterText" : string , "sendMessageDenyNotification" : string , "defaultMessageDenyNotificationText" : string , "showInGroupDirectory" : string , "allowGoogleCommunication" : string , "membersCanPostAsTheGroup" : string , "messageDisplayFont" : string , "includeInGlobalAddressList" : string , "whoCanLeaveGroup" : string , "whoCanContactOwner" : string , "whoCanAddReferences" : string , "whoCanAssignTopics" : string , "whoCanUnassignTopic" : string , "whoCanTakeTopics" : string , "whoCanMarkDuplicate" : string , "whoCanMarkNoResponseNeeded" : string , "whoCanMarkFavoriteReplyOnAnyTopic" : string , "whoCanMarkFavoriteReplyOnOwnTopic" : string , "whoCanUnmarkFavoriteReplyOnAnyTopic" : string , "whoCanEnterFreeFormTags" : string , "whoCanModifyTagsAndCategories" : string , "favoriteRepliesOnTop" : string , "whoCanApproveMembers" : string , "whoCanBanUsers" : string , "whoCanModifyMembers" : string , "whoCanApproveMessages" : string , "whoCanDeleteAnyPost" : string , "whoCanDeleteTopics" : string , "whoCanLockTopics" : string , "whoCanMoveTopicsIn" : string , "whoCanMoveTopicsOut" : string , "whoCanPostAnnouncements" : string , "whoCanHideAbuse" : string , "whoCanMakeTopicsSticky" : string , "whoCanModerateMembers" : string , "whoCanModerateContent" : string , "whoCanAssistContent" : string , "customRolesEnabledForSettingsToBeMerged" : string , "enableCollaborativeInbox" : string , "whoCanDiscoverGroup" : string , "defaultSender" : string }
The following table shows the Groups resources:
kind
string
groupsSettings#groups
.name
string
description
string
whoCanJoin
string
-
ANYONE_CAN_JOIN
: Any internet user, both inside and outside your domain, can join the group. -
ALL_IN_DOMAIN_CAN_JOIN
: Anyone in the account domain can join. This includes accounts with multiple domains. -
INVITED_CAN_JOIN
: Candidates for membership can be invited to join. -
CAN_REQUEST_TO_JOIN
: Non members can request an invitation to join.
whoCanViewMembership
string
-
ALL_IN_DOMAIN_CAN_VIEW
: Anyone in the account can view the group members list.If a group already has external members, those members can still send email to this group.
-
ALL_MEMBERS_CAN_VIEW
: The group members can view the group members list. -
ALL_MANAGERS_CAN_VIEW
: The group managers can view group members list.
whoCanViewGroup
string
-
ANYONE_CAN_VIEW
: Any internet user can view the group's messages. -
ALL_IN_DOMAIN_CAN_VIEW
: Anyone in your account can view this group's messages. -
ALL_MEMBERS_CAN_VIEW
: All group members can view the group's messages. -
ALL_MANAGERS_CAN_VIEW
: Any group manager can view this group's messages.
whoCanInvite
string
whoCanModerateMembers
setting. Permissions to invite new members. Possible values are: -
ALL_MEMBERS_CAN_INVITE
: Managers and members can invite a new member candidate. -
ALL_MANAGERS_CAN_INVITE
: Only managers can invite a new member. This includes the group's owner. -
ALL_OWNERS_CAN_INVITE
: Only owners can invite a new member. -
NONE_CAN_INVITE
: No one can invite a new member candidate.
whoCanAdd
string
whoCanModerateMembers
setting. Permissions to add members. Possible values are: -
ALL_MEMBERS_CAN_ADD
: Managers and members can directly add new members. -
ALL_MANAGERS_CAN_ADD
: Only managers can directly add new members. this includes the group's owner. -
ALL_OWNERS_CAN_ADD
: Only owners can directly add new members. -
NONE_CAN_ADD
: No one can directly add new members.
allowExternalMembers
string
-
true
: Google Workspace users external to your organization can become members of this group. -
false
: Users not belonging to the organization are not allowed to become members of this group.
whoCanPostMessage
string
-
NONE_CAN_POST
: The group is disabled and archived. No one can post a message to this group.- When
archiveOnly
isfalse
, updatingwhoCanPostMessage
toNONE_CAN_POST
, results in an error. - If
archiveOnly
is reverted fromtrue
tofalse
,whoCanPostMessages
is set toALL_MANAGERS_CAN_POST
.
- When
-
ALL_MANAGERS_CAN_POST
: Managers, including group owners, can post messages. -
ALL_MEMBERS_CAN_POST
: Any group member can post a message. -
ALL_OWNERS_CAN_POST
: Only group owners can post a message. -
ALL_IN_DOMAIN_CAN_POST
: Anyone in the account can post a message. -
ANYONE_CAN_POST
: Any internet user who outside your account can access your Google Groups service and post a message.
allowWebPosting
string
-
true
: Allows any member to post to the group forum. -
false
: Members only use Gmail to communicate with the group.
primaryLanguage
string
maxMessageBytes
integer
isArchived
string
-
true
: Archive messages sent to the group. -
false
: Do not keep an archive of messages sent to this group. Iffalse
, previously archived messages remain in the archive.
archiveOnly
string
-
true
: Group is archived and the group is inactive. New messages to this group are rejected. The older archived messages are browseable and searchable.- If
true
, thewhoCanPostMessage
property is set toNONE_CAN_POST
. - If reverted from
true
tofalse
, whoCanPostMessages is set toALL_MANAGERS_CAN_POST
.
- If
-
false
: The group is active and can receive messages.- When
false
, updatingwhoCanPostMessage
toNONE_CAN_POST
, results in an error.
- When
spamModerationLevel
string
-
ALLOW
: Post the message to the group. -
MODERATE
: Send the message to the moderation queue. This is the default. -
SILENTLY_MODERATE
: Send the message to the moderation queue, but do not send notification to moderators. -
REJECT
: Immediately reject the message.
replyTo
string
-
REPLY_TO_CUSTOM
: For replies to messages, use the group's custom email address.When the group's
ReplyTo
property is set toREPLY_TO_CUSTOM
, thecustomReplyTo
property holds the custom email address used when replying to a message. If the group'sReplyTo
property is set toREPLY_TO_CUSTOM
, thecustomReplyTo
property must have a value. Otherwise an error is returned. -
REPLY_TO_SENDER
: The reply sent to author of message. -
REPLY_TO_LIST
: This reply message is sent to the group. -
REPLY_TO_OWNER
: The reply is sent to the owner(s) of the group. This does not include the group's managers. -
REPLY_TO_IGNORE
: Group users individually decide where the message reply is sent. -
REPLY_TO_MANAGERS
: This reply message is sent to the group's managers, which includes all managers and the group owner.
customReplyTo
string
replyTo
property is set to REPLY_TO_CUSTOM
. This address is defined by an account administrator. - When the group's
ReplyTo
property is set toREPLY_TO_CUSTOM
, thecustomReplyTo
property holds a custom email address used when replying to a message. - If the group's
ReplyTo
property is set toREPLY_TO_CUSTOM
, thecustomReplyTo
property must have a text value or an error is returned.
sendMessageDenyNotification
string
-
true
: When a message is rejected, send the deny message notification to the message author.The
defaultMessageDenyNotificationText
property is dependent on thesendMessageDenyNotification
property beingtrue
. -
false
: When a message is rejected, no notification is sent.
defaultMessageDenyNotificationText
string
showInGroupDirectory
string
whoCanDiscoverGroup
setting. Allows the group to be visible in the Groups Directory. Possible values are: -
true
: All groups in the account are listed in the Groups directory. -
false
: All groups in the account are not listed in the directory.
allowGoogleCommunication
string
-
true
: Allow Google to contact managers of this group. Occasionally Google may send updates on the latest features, ask for input on new features, or ask for permission to highlight your group. -
false
: Google can not contact managers of this group.
membersCanPostAsTheGroup
string
-
true
: Group member can post messages using the group's email address instead of their own email address. Message appear to originate from the group itself. -
false
: Members can not post in behalf of the group's email address.
includeInGlobalAddressList
string
-
true
: Group is included in the Global Address List. -
false
: Group is not included in the Global Address List.
whoCanLeaveGroup
string
-
ALL_MANAGERS_CAN_LEAVE
-
ALL_MEMBERS_CAN_LEAVE
-
NONE_CAN_LEAVE
whoCanContactOwner
string
-
ALL_IN_DOMAIN_CAN_CONTACT
-
ALL_MANAGERS_CAN_CONTACT
-
ALL_MEMBERS_CAN_CONTACT
-
ANYONE_CAN_CONTACT
whoCanAddReferences
string
whoCanAssignTopics
string
whoCanAssistContent
setting. Permission to assign topics in a forum to another user. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
whoCanUnassignTopic
string
whoCanAssistContent
setting. Permission to unassign any topic in a forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
whoCanTakeTopics
string
whoCanAssistContent
setting. Permission to take topics in a forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
whoCanMarkDuplicate
string
whoCanAssistContent
setting. Permission to mark a topic as a duplicate of another topic. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
whoCanMarkNoResponseNeeded
string
whoCanAssistContent
setting. Permission to mark a topic as not needing a response. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
whoCanMarkFavoriteReplyOnAnyTopic
string
whoCanAssistContent
setting. Permission to mark any other user's post as a favorite reply. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
whoCanMarkFavoriteReplyOnOwnTopic
string
whoCanAssistContent
setting. Permission to mark a post for a topic they started as a favorite reply. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
whoCanUnmarkFavoriteReplyOnAnyTopic
string
whoCanAssistContent
setting. Permission to unmark any post from a favorite reply. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
whoCanEnterFreeFormTags
string
whoCanAssistContent
setting. Permission to enter free form tags for topics in a forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
whoCanModifyTagsAndCategories
string
whoCanAssistContent
setting. Permission to change tags and categories. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
favoriteRepliesOnTop
string
-
true
: Favorite replies are displayed before other replies. -
false
: Favorite replies aren't displayed before other replies.
whoCanApproveMembers
string
whoCanModerateMembers
setting. Possible values are: -
ALL_MEMBERS_CAN_APPROVE
-
ALL_MANAGERS_CAN_APPROVE
-
ALL_OWNERS_CAN_APPROVE
-
NONE_CAN_APPROVE
whoCanBanUsers
string
whoCanModerateMembers
setting. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanModifyMembers
string
whoCanModerateMembers
setting. Specifies who can change group members' roles. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanApproveMessages
string
whoCanModerateContent
setting. Specifies who can approve pending messages in the moderation queue. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanDeleteAnyPost
string
whoCanModerateContent
setting. Specifies who can delete replies to topics. (Authors can always delete their own posts). Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanDeleteTopics
string
whoCanModerateContent
setting. Specifies who can delete topics. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanLockTopics
string
whoCanModerateContent
setting. Specifies who can prevent users from posting replies to topics. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanMoveTopicsIn
string
whoCanModerateContent
setting. Specifies who can move topics into the group or forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanMoveTopicsOut
string
whoCanModerateContent
setting. Specifies who can move topics out of the group or forum. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanPostAnnouncements
string
whoCanModerateContent
setting. Specifies who can post announcements, a special topic type. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanHideAbuse
string
whoCanModerateContent
setting. Specifies who can hide posts by reporting them as abuse. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanMakeTopicsSticky
string
whoCanModerateContent
setting. Specifies who can make topics appear at the top of the topic list. Possible values are: -
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanModerateMembers
string
-
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanModerateContent
string
-
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
OWNERS_ONLY
-
NONE
whoCanAssistContent
string
-
ALL_MEMBERS
-
OWNERS_AND_MANAGERS
-
MANAGERS_ONLY
-
OWNERS_ONLY
-
NONE
customRolesEnabledForSettingsToBeMerged
string
UPDATE
and PATCH
requests to it are ignored. Possible values are: -
true
-
false
enableCollaborativeInbox
string
-
true
-
false
whoCanDiscoverGroup
string
-
ANYONE_CAN_DISCOVER
-
ALL_IN_DOMAIN_CAN_DISCOVER
-
ALL_MEMBERS_CAN_DISCOVER
defaultSender
string
-
DEFAULT_SELF
-
GROUP
Methods
The groupsSettings.groups.get and groupsSettings.groups.update methods operate on a specified Groups Resource .
Supported languages
The following language codes are supported for a group's primaryLanguage
field.
aa ab af am ar as ay az ba be bg bh bi bn bo br bs ca co cs cy da de dz el en en-GB en-US-pseudo en_US eo es et eu fa fi fj fo fr |
fr-CA fy ga gd gl gn gu ha hi hr hu hy ia id ie ik is it iu iw ja jw ka kk kl km kn ko ks ku ky la ln lo lt lv mg mi |
mk ml mn mo mr ms mt my na ne nl nn no oc om or pa pl ps pt-BR pt-PT qu rm rn ro ru rw sa sd sg sh si sk sl sm sn so sq |
sr ss st su sv sw ta te tg th ti tk tl tn to tr ts tt tw ug uk ur uz vi vo wo xh xx-bork xx-elmer xx-hacker xx-klingon xx-piglatin yi yo za zh-CN zh-TW zu |