Group Information

Get information about a Chatter group.
Resource
/chatter/groups/groupId
/connect/communities/communityId/chatter/groups/groupId
Available version
23.0
Requires Chatter
Yes
HTTP methods
GET, DELETE, HEAD, PATCH
PATCH is supported in version 28.0 later.
DELETE is supported in version 29.0 and later.
Request body for PATCH
Group Input
Root XML Tag
<group>
JSON
{
   "announcement" : "0D5D0000000K4XT",
   "canHaveChatterGuests" : "true",
   "description" : "This group is building a powerful API.",
   "information" : {
      "text" : "Read this section before you post to the group.",
      "title" : "Information"
   },
   "isArchived" : "false",
   "isAutoArchiveDisabled" : "false",
   "name" : "Chatter API",
   "owner" : "00590000000DmPw",
   "visibility" : "PublicAccess"
}
Properties
Name Type Description Available Version
announcement String An announcement ID.

An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.

31.0
canHaveChatterGuests Boolean true if this group allows Chatter customers, false otherwise. After this property is set to true, it cannot be set to false. 29.0
description String The “Description” section of the group 29.0
information Group Information Input The “Information” section of the groupIf the group is private, the “Information” section is visible only to members. The “Description” section is visible to everyone. 28.0
isArchived Boolean true if the group is archived, false otherwise. Defaults to false. 29.0
isAutoArchiveDisabled Boolean true if automatic archiving is turned off for the group, false otherwise. Defaults to false. 29.0
isBroadcast Boolean true if only group owners and managers can create posts in the group, false otherwise. Defaults to false. 36.0
name String The name of the group 29.0
owner String The ID of the group owner. This property is available for PATCH requests only. 29.0
visibility String Group visibility type. One of the following values:
  • PrivateAccess—Only members of the group can see posts to this group.
  • PublicAccess—All users within the Experience Cloud site can see posts to this group.
  • Unlisted—Reserved for future use.
29.0
Group Information Input
JSON
{
   "text" : "Post questions about the API.",
   "title" : "API Questions"
}
Properties
Name Type Description Available Version
text String The text in the “Information” section of the group. HTML is not supported. The maximum length is 4000 characters (bytes). 28.0
title String The title in the “Information” section of the group. The maximum length is 240 characters (bytes). 28.0
Request parameters for PATCH
Property Type Description Required or Optional Available Version
announcement String The ID of a feed item to use as an announcement.

An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.

Optional 31.0
canHave​ChatterGuests Boolean true if this group allows Chatter customers, false otherwise. After this property is set to true, it cannot be set to false. Optional 29.0
description String The “Description” section of the group. Optional 29.0
information​Text String The “Information” section of the group. If the group is private, the “Information” section is visible only to members. The “Description” section is visible to everyone. Optional 28.0
information​Title String The title of the “Information” section of the group. Optional 28.0
isArchived String true if the group is archived, false otherwise. Defaults to false. Optional 29.0
isAutoArchive​Disabled Boolean true if automatic archiving is turned off for the group, false otherwise. Defaults to false. Optional 29.0
isBroadcast Boolean true if only group owners and managers can create posts in the group, false otherwise. Defaults to false. Optional 36.0
name String The name of the group. Optional 29.0
owner String The ID of the group owner. This property is available for PATCH requests only. Optional 29.0
visibility String Group visibility type. One of the following values:
  • PrivateAccess—Only members of the group can see posts to this group.
  • PublicAccess—All users within the Experience Cloud site can see posts to this group.
  • Unlisted—Reserved for future use.
Optional 29.0
Response body for GET and PATCH
Group Detail
Example for PATCH
This request body updates the text and title of the “Information” section of a group:
{
   "information" : {
      "text" : "Post questions about the API to this group. If you have the answer to a question, please post it. This is a private R&D group.",
      "title" : "API Questions Group"
   }
}
Here is the same example using request parameters:
https://instance_name/services/data/64.0/chatter/groups/groupId
?informationText=Post+questions+about+the+API+to+this+group.+If+you+have+the+answer+to+a+question%2C%20
+please+post+it.+This+is+a+private+R%26amp%3Bamp%3BD+group.&informationTitle=API+Questions+Group
The response is a Group Detail response body.