CollaborationGroup

Represents a Chatter group. This object is available in API version 19.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

Fields

Field	Details
CanHaveGuests	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If set to `true`, indicates that a group allows customers. Chatter customers are users outside your company's email domains who can only see groups they're invited to and interact with members of those groups; they can't see any Salesforce information. This field is available starting in API version 23.0, but groups that allow customers are accessible from earlier API versions. However, when accessed from earlier API versions, groups that allow customers aren't distinguishable from private groups. We strongly recommend that you upgrade to the latest API version. If you must use an earlier version, name groups that allow customers to indicate that they include customers.
CollaborationType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of Chatter group. Available values are: `Public`—Anyone can see the group's updates, but only members can post updates. Anyone can join a public group. `Private`—Only members can see and post updates. The group's owner or managers must add members.
Description	Type string Properties Create, Filter, Nillable, Sort, Update Description Description of the group.
FullPhotoUrl	Type string Properties Filter, Nillable, Sort Description The URL for the group's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo. This field is available in API version 20.0 and later.
HasPrivateFieldsAccess	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If set to `true`, indicates that a user can see the InformationBody and InformationTitle fields in a private group. This field is set to `true` for members of a private group and users with “Modify All Data” or “View All Data” permissions.
InformationBody	Type textarea Properties Create, Nillable, Update Description The text of the Information section. For private groups, only visible to members and users with “Modify All Data” or “View All Data” permissions.
InformationTitle	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The title of the Information section. For private groups, only visible to members and users with “Modify All Data” or “View All Data” permissions.
LastFeedModifiedDate	Type dateTime Properties Filter, Sort Description The date of the last post or comment on the group.
MemberCount	Type int Properties Filter, Group, Nillable, Sort Description The number of members in the group.
Name	Type string Properties Create, Filter, Group, Sort, Update Description Name of the group.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of the group. Only the current group owner or people with the “Modify All Data” permission can update the OwnerId.
SmallPhotoUrl	Type string Properties Filter, Nillable, Sort Description The URL for a thumbnail of the group's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo. This field is available in API version 20.0 and later.

Usage

Use this object to create, edit, or delete Chatter groups. Anyone can create a group, however, you must own or manage a group in order to edit it. To delete a group, you must be the group owner or have the “Modify All Data” permission. Deleting a group permanently deletes all posts and comments to the group. It also deletes all files and links posted to the group and removes the files from other locations where they were shared.

As a Chatter group member, you can post to the group using the CollaborationGroupFeed object. As a Chatter group owner or manager, you can add or remove group members using the CollaborationGroupMember object, and accept or decline requests to join private groups using the CollaborationGroupMemberRequest object. Additionally, the group owner, manager, or your Salesforce system administrator can invite people to join the group using the CollaborationInvitation object.

Note

The Salesforce system administrator doesn’t need to be a member of the group in order to send invitations using the API.