ChatterGroups Class

getGroup(communityId, groupId)

Get information about a group.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupDetail getGroup(String communityId, String groupId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.

Return Value

Type: ConnectApi.ChatterGroupDetail

getGroupBatch(communityId, groupIds)

Get information about a list of groups.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] getGroupBatch(String communityId, List<String> groupIds)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupIds: Type: List<String>; A list of up to 500 group IDs.

Return Value

Type: ConnectApi.BatchResult[]

The ConnectApi.BatchResult.getResult() method returns a ConnectApi.ChatterGroup object and errors embedded in the results for groups that didn’t load.

Example

// Create a list of groups.
ConnectApi.ChatterGroupPage groupPage = ConnectApi.ChatterGroups.getGroups(null);

// Create a list of group IDs.
List<String> groupIds = new List<String>();
for (ConnectApi.ChatterGroup aGroup : groupPage.groups){
    groupIds.add(aGroup.id); 
}

// Get info about all the groups in the list.
ConnectApi.BatchResult[] batchResults = ConnectApi.ChatterGroups.getGroupBatch(null, groupIds);
    
for (ConnectApi.BatchResult batchResult : batchResults) {
    if (batchResult.isSuccess()) {
        // Operation was successful. 
        // Print the number of members in each group.
        ConnectApi.ChatterGroup aGroup;
        if(batchResult.getResult() instanceof ConnectApi.ChatterGroup) {
           aGroup = (ConnectApi.ChatterGroup) batchResult.getResult();
        }
        System.debug('SUCCESS');
        System.debug(aGroup.memberCount);
    }
    else {
        // Operation failed. Print errors.
        System.debug('FAILURE');
        System.debug(batchResult.getErrorMessage());
    }
}

getGroupMembershipRequest(communityId, requestId)

Get information about a request to join a private group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequest getGroupMembershipRequest(String communityId, String requestId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
requestId: Type: String; The ID of a request to join a private group.

Return Value

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

getGroupMembershipRequests(communityId, groupId)

Get information about every request to join a private group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequests getGroupMembershipRequests(String communityId, String groupId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.

Return Value

Type: ConnectApi.GroupMembershipRequests

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

getGroupMembershipRequests(communityId, groupId, status)

Get information about every request to join a private group that has a specified status.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequests getGroupMembershipRequests(String communityId, String groupId, ConnectApi.GroupMembershipRequestStatus status)

Parameters

communityId

Type: String

ID for an Experience Cloud site, internal, or null.

groupId

Type: String

ID for a group.

status

Type: ConnectApi.GroupMembershipRequestStatus

status—Status of a request to join a private group.

Accepted
Declined
Pending

Return Value

Type: ConnectApi.GroupMembershipRequests

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

getGroups(communityId)

Get the first page of groups.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage getGroups(String communityId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.

Return Value

getGroups(communityId, pageParam, pageSize)

Get a page of groups.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage getGroups(String communityId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
pageParam: Type: Integer; Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getGroups(communityId, pageParam, pageSize, archiveStatus)

Get a page of groups with an archive status.

API Version

29.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage getGroups(String communityId, Integer pageParam, Integer pageSize, ConnectApi.GroupArchiveStatus archiveStatus)

Parameters

communityId

Type: String

ID for an Experience Cloud site, internal, or null.

pageParam

Type: Integer

Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

archiveStatus

Type: ConnectApi.GroupArchiveStatus

Archive status of groups.

All—All groups, including groups that are archived and groups that aren’t archived.
Archived—Groups that are archived.
NotArchived—Groups that aren’t archived.

If you pass in null, the default value is All.

Return Value

getMember(communityId, membershipId)

Get information about a group member.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMember getMember(String communityId, String membershipId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
membershipId: Type: String; ID for a membership.

Return Value

Type: ConnectApi.GroupMember

getMembers(communityId, groupId)

Get the first page of information about the members of a group.

API Version

28.0

Available to Guest Users

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMemberPage getMembers(String communityId, String groupId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.

Return Value

Type: ConnectApi.GroupMemberPage

getMembers(communityId, groupId, pageParam, pageSize)

Get a page of information about the members of a group.

API Version

28.0

Available to Guest Users

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMemberPage getMembers(String communityId, String groupId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.
pageParam: Type: Integer; Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.GroupMemberPage

getMembershipBatch(communityId, membershipIds)

Get information about a list of group memberships.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] getMembershipBatch(String communityId, List<String> membershipIds)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
membershipIds: Type: List<String>; A list of up to 500 group membership IDs.

Return Value

Type: ConnectApi.BatchResult[]

The ConnectApi.BatchResult.getResult() method returns a ConnectApi.GroupMember object and errors embedded in the results for group memberships that didn’t load.

Example

// Get members of a group.
ConnectApi.GroupMemberPage membersPage = ConnectApi.ChatterGroups.getMembers(null, '0F9D00000000oOT');

// Create a list of membership IDs.
List<String> membersList = new List<String>();
for (ConnectApi.GroupMember groupMember : membersPage.members){
    membersList.add(groupMember.id); 
}

// Get info about all group memberships in the list.
ConnectApi.BatchResult[] batchResults = ConnectApi.ChatterGroups.getMembershipBatch(null, membersList);

for (ConnectApi.BatchResult batchResult : batchResults) {
    if (batchResult.isSuccess()) {
        // Operation was successful. 
        // Print the first name of each member.
        ConnectApi.GroupMember groupMember;
        if(batchResult.getResult() instanceof ConnectApi.GroupMember) {
            groupMember = (ConnectApi.GroupMember) batchResult.getResult();
        }
        System.debug('SUCCESS');
        System.debug(groupMember.user.firstName);
    }
    else {
        // Operation failed. Print errors.
        System.debug('FAILURE');
        System.debug(batchResult.getErrorMessage());
    }
}

getMyChatterSettings(communityId, groupId)

Get the context user’s Chatter settings for a group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupChatterSettings getMyChatterSettings(String communityId, String groupId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.

Return Value

Type: ConnectApi.GroupChatterSettings

getPhoto(communityId, groupId)

Get the photo for a group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo getPhoto(String communityId, String groupId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.

Return Value

Type: ConnectApi.Photo

getRecord(communityId, groupRecordId)

Get a record associated with a group.

API Version

34.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupRecord getRecord(String communityId, String groupRecordId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupRecordId: Type: String; ID of the group record.

Return Value

Type: ConnectApi.GroupRecord

getRecords(communityId, groupId)

Get the first page of records associated with a group.

API Version

33.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupRecordPage getRecords(String communityId, String groupId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.

Return Value

Type: ConnectApi.GroupRecordPage

getRecords(communityId, groupId, pageParam, pageSize)

Get a page of records associated with a group.

API Version

33.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupRecordPage getRecords(String communityId, String groupId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.
pageParam: Type: Integer; Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.GroupRecordPage

inviteUsers(groupId, invite)

Invite internal and external users to join a group.

API Version

39.0

Requires Chatter

Yes

Signature

public static ConnectApi.Invitations inviteUsers(String groupId, ConnectApi.InviteInput invite)

Parameters

groupId: Type: String; ID of the group.
invite: Type: ConnectApi.InviteInput; A ConnectApi.InviteInput body.

Return Value

Type: ConnectApi.Invitations

postAnnouncement(communityId, groupId, announcement)

Post an announcement to a group.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.Announcement postAnnouncement(String communityId, String groupId, ConnectApi.AnnouncementInput announcement)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.
announcement: Type: ConnectApi.AnnouncementInput; A ConnectApi.AnnouncementInput object.

Return Value

Type: ConnectApi.Announcement

Usage

Use an announcement to highlight information. Users can discuss, like, and post comments on announcements. Deleting the feed post deletes the announcement.

To post an announcement, get information about an announcement, update the expiration date of an announcement, or delete an announcement, use the methods of the ConnectApi.Announcements class.

removeRecord(communityId, groupRecordId)

Remove the association of a record with a group.

API Version

34.0

Requires Chatter

Yes

Signature

public static Void removeRecord(String communityId, String groupRecordId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupRecordId: Type: String; ID of the group record.

Return Value

Type: Void

requestGroupMembership(communityId, groupId)

Request membership in a private group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequest requestGroupMembership(String communityId, String groupId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.

Return Value

Sample: Requesting to Join a Private Group

This sample code calls ConnectApi.ChatterGroups.requestGroupMembership to request to join a private group.

String communityId = null;
ID groupId = '0F9x00000000hAZ';

ConnectApi.GroupMembershipRequest membershipRequest = ConnectApi.ChatterGroups.requestGroupMembership(communityId, groupId);

searchGroups(communityId, q)

Get the first page of groups that match the search criteria.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage searchGroups(String communityId, String q)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
q: Type: String; Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards. Can be specified as null.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchGroups(communityId, q, pageParam, pageSize)

Get a page of groups that match the search criteria.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage searchGroups(String communityId, String q, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
q: Type: String; Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards. Can be specified as null.
pageParam: Type: Integer; Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchGroups(communityId, q, archiveStatus, pageParam, pageSize)

Get a page of groups with the archive status that match the search criteria.

API Version

29.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage searchGroups(String communityId, String q, ConnectApi.GroupArchiveStatus archiveStatus, Integer pageParam, Integer pageSize)

Parameters

communityId

Type: String

ID for an Experience Cloud site, internal, or null.

q

Type: String

Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards. Can be specified as null.

archiveStatus

Type: ConnectApi.GroupArchiveStatus

Archive status of groups.

All—All groups, including groups that are archived and groups that aren’t archived.
Archived—Groups that are archived.
NotArchived—Groups that aren’t archived.

pageParam

Type: Integer

Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

setBannerPhoto(communityId, groupId, fileId, versionNumber)

Set an uploaded file as the group banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.BannerPhoto setBannerPhoto(String communityId, String groupId, String fileId, Integer versionNumber)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; The ID of the group.
fileId: Type: String; The ID of the already uploaded file. The key prefix must be 069, and the image must be smaller than 8 MB.
versionNumber: Type: Integer; Version number of the existing file. Specify either an existing version number or, to get the latest version, specify null.

Return Value

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

Photos are processed asynchronously and might not be visible right away.

setBannerPhoto(communityId, groupId, fileUpload)

Set a file that hasn’t been uploaded as the group banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.BannerPhoto setBannerPhoto(String communityId, String groupId, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; The ID of the group.
fileUpload: Type: ConnectApi.BinaryInput; File to use as the photo. The content type must be usable as an image.

Return Value

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

Photos are processed asynchronously and might not be visible right away.

setBannerPhotoWithAttributes(communityId, groupId, bannerPhoto)

Set and crop an uploaded file as the group banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.BannerPhoto setBannerPhotoWithAttributes(String communityId, String groupId, ConnectApi.BannerPhotoInput bannerPhoto)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; The ID of the group.
bannerPhoto: Type: ConnectApi.BannerPhotoInput; A ConnectApi.BannerPhotoInput object that specifies the ID and version of the file, and how to crop the file.

Return Value

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

Photos are processed asynchronously and might not be visible right away.

setBannerPhotoWithAttributes(communityId, groupId, bannerPhoto, fileUpload)

Set and crop a file that hasn’t been uploaded as the group banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.BannerPhoto setBannerPhotoWithAttributes(String communityId, String groupId, ConnectApi.BannerPhotoInput bannerPhoto, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; The ID of the group.
bannerPhoto: Type: ConnectApi.BannerPhotoInput; A ConnectApi.BannerPhotoInput object specifying the cropping parameters.
fileUpload: Type: ConnectApi.BinaryInput; File to use as the photo. The content type must be usable as an image.

Return Value

Type: ConnectApi.GroupEmailFrequency

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

Photos are processed asynchronously and might not be visible right away.

setPhoto(communityId, groupId, fileId, versionNumber)

Set an uploaded file as the group photo.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhoto(String communityId, String groupId, String fileId, Integer versionNumber)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.
fileId: Type: String; ID of a file already uploaded. The key prefix must be 069, and the file must be an image that is smaller than 2 GB.
versionNumber: Type: Integer; Version number of the existing file. Specify either an existing version number or, to get the latest version, specify null.

Return Value

Type: ConnectApi.Photo

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

Photos are processed asynchronously and might not be visible right away.

Sample: Updating a Group Photo with an Existing File

When a group is created, it doesn’t have a group photo. You can set an existing photo that has already been uploaded to Salesforce as the group photo. The key prefix must be 069 and the file size must be less than 2 GB.

String communityId = null;
ID groupId = '0F9x00000000hAK';
ID fileId = '069x00000001Ion';

// Set photo
ConnectApi.Photo photo = ConnectApi.ChatterGroups.setPhoto(communityId, groupId, fileId, null);

setPhoto(communityId, groupId, fileUpload)

Set a file that hasn’t been uploaded as the group photo.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhoto(String communityId, String groupId, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.
fileUpload: Type: ConnectApi.BinaryInput; File to use as the photo. The content type must be usable as an image.

Return Value

Type: ConnectApi.Photo

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

Photos are processed asynchronously and might not be visible right away.

Sample: Uploading a New File and Using It as a Group Photo

When a group is created, it doesn’t have a group photo. You can upload a photo and set it as the group photo.

String communityId = null;
ID groupId = '0F9x00000000hAP';
ID photoId = '069x00000001Ioo';

// Set photo
List<ContentVersion> groupPhoto = [Select c.VersionData From ContentVersion c where ContentDocumentId=:photoId];
ConnectApi.BinaryInput binary = new ConnectApi.BinaryInput(groupPhoto.get(0).VersionData, 'image/png', 'image.png');
ConnectApi.Photo photo = ConnectApi.ChatterGroups.setPhoto(communityId, groupId, binary);

setPhotoWithAttributes(communityId, groupId, photo)

Set and crop an uploaded file as the group photo.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhotoWithAttributes(String communityId, String groupId, ConnectApi.PhotoInput photo)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.
photo: Type: ConnectApi.PhotoInput; A ConnectApi.PhotoInput object that specifies the ID and version of the file, and how to crop the file.

Return Value

Type: ConnectApi.Photo

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

Photos are processed asynchronously and might not be visible right away.

setPhotoWithAttributes(communityId, groupId, photo, fileUpload)

Set and crop a file that hasn’t been uploaded as the group photo.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhotoWithAttributes(String communityId, String groupId, ConnectApi.PhotoInput photo, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.
photo: Type: ConnectApi.PhotoInput; A ConnectApi.PhotoInput object that specifies how to crop the file specified in fileUpload.
fileUpload: Type: ConnectApi.BinaryInput; File to use as the photo. The content type must be usable as an image.

Return Value

Type: ConnectApi.Photo

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

Photos are processed asynchronously and might not be visible right away.

updateGroup(communityId, groupId, groupInput)

Update the settings of a group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroup updateGroup(String communityId, String groupId, ConnectApi.ChatterGroupInput groupInput)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
groupId: Type: String; ID for a group.
groupInput: Type: ConnectApi.ChatterGroupInput; A ConnectApi.ChatterGroupInput object.

Return Value

Type: ConnectApi.ChatterGroup

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission. Use this method to update any settings in the ConnectApi.ChatterGroupInput class. These settings include the group title and text in the “Information” section, whether the group is public or private, and whether the group is archived.

Example

This example archives a group.

String groupId = '0F9D00000000qSz';
String communityId = null;

ConnectApi.ChatterGroupInput groupInput = new ConnectApi.ChatterGroupInput();
groupInput.isArchived = true;

ConnectApi.ChatterGroups.updateGroup(communityId, groupId, groupInput);

updateGroupMember(communityId, membershipId, role)

Update the role of a group member.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroup updateGroupMember(String communityId, String membershipId, ConnectApi.GroupMembershipType role)

Parameters

communityId

Type: String

ID for an Experience Cloud site, internal, or null.

membershipId

Type: String

ID for a membership.

role

Type: ConnectApi.GroupMembershipType

The group membership type. One of these values:

GroupManager
StandardMember

Return Value

Type: ConnectApi.ChatterGroup

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

updateMyChatterSettings(communityId, groupId, emailFrequency)

Update the context user’s email frequency for a group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupChatterSettings updateMyChatterSettings(String communityId, String groupId, ConnectApi.GroupEmailFrequency emailFrequency)

Parameters

communityId

Type: String

ID for an Experience Cloud site, internal, or null.

groupId

Type: String

ID for a group.

emailFrequency

Frequency with which a user receives email.

EachPost
DailyDigest
WeeklyDigest
Never
UseDefault

The value UseDefault uses the value set in a call to updateChatterSettings(communityId, userId, defaultGroupEmailFrequency).

Return Value

Type: ConnectApi.GroupChatterSettings

updateRequestStatus(communityId, requestId, status)

Update a request to join a private group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequest updateRequestStatus(String communityId, String requestId, ConnectApi.GroupMembershipRequestStatus status)

Parameters

communityId

Type: String

ID for an Experience Cloud site, internal, or null.

requestId

Type: String

ID for a request to join a private group.

status

Type: ConnectApi.GroupMembershipRequestStatus

Status of the request:

Accepted
Declined

The Pending value of the enum is not valid in this method.

Return Value

Usage

This method is successful only when the context user is the group manager or owner, or has Modify All Data permission.

Sample: Accepting or Declining a Request to Join a Private Group

This sample code calls ConnectApi.ChatterGroups.updateRequestStatus and passes it the membership request ID and an ConnectApi.GroupMembershipRequestStatus.Accepted status. You can also pass ConnectApi.GroupMembershipRequestStatus.Declined.

String communityId = null;
ID groupId = '0F9x00000000hAZ';
String requestId = '0I5x000000001snCAA';

ConnectApi.GroupMembershipRequest membershipRequestRep = ConnectApi.ChatterGroups.updateRequestStatus(communityId, requestId, 
ConnectApi.GroupMembershipRequestStatus.Accepted);

updateRequestStatus(communityId, requestId, status, responseMessage)

Update a request to join a private group and optionally provide a message when the request is denied.

API Version

35.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequest updateRequestStatus(String communityId, String requestId, ConnectApi.GroupMembershipRequestStatus status, String responseMessage)

Parameters

communityId

Type: String

ID for an Experience Cloud site, internal, or null.

requestId

Type: String

ID for a request to join a private group.

status

Type: ConnectApi.GroupMembershipRequestStatus

Status of the request:

Accepted
Declined

The Pending value of the enum is not valid in this method.

responseMessage

Type: String

Provide a message to the user if their membership request is declined. The value of this property is used only when the value of the status property is Declined.

The maximum length is 756 characters.

Return Value