Chatter REST API Developer Guide

Introducing Chatter REST API
Chatter REST API Quick Start
Chatter REST API Features
Working with Action Links
Working with Communities
Working with Feeds and Feed Elements
Working with Salesforce Files
Chatter REST API Examples
Chatter REST API Resources
Chatter REST API Request Bodies
Chatter REST API Response Bodies
Chatter REST API Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Working with Communities

Communities are branded spaces for your employees, customers, and partners to connect. You can customize and create communities to meet your business needs, then transition seamlessly between them.

You can request most Chatter REST API resources within a specific community. For example, you can make requests to feeds, files, groups, topics, and users resources within a specific community. If a resource is available in communities, its documentation includes a resource that starts with /connect/communities/communityId.

Some Chatter REST API resources are available only within a community. These include resources for flagging and moderating content, using managed topics, and getting information about a user’s reputation.

Resources that are available in communities are available whether you allow access without logging in or not. However, if your community allows access without logging in, guest users don’t have access to any Chatter REST API resources.

The resources that are available only within a community are listed in this table.

Resource HTTP Methods Tasks
/connect/communities GET Returns a list of all communities available to the context user.
/connect/communities/communityId GET Returns information about the specified community.
/connect/communities/communityId/​chatter/comments/commentId/​moderation-flags GET, POST, DELETE If the context user is a community moderator, get the number of times community members flagged a comment. Also flag a comment for moderation and delete all flags on a comment.

If the context user isn’t a community moderator, returns whether the user flagged a comment. Also flag a comment for moderation and remove a flag the user previously added.
/connect/communities/communityId/​chatter/feed-elements/feedElementId/​capabilities/moderation GET, POST, DELETE Get information about a feed element's moderation capability, add a moderation flag to a feed element, or delete all moderation flags from a feed element.
/connect/communities/communityId/​files/moderation GET

If the context user is a community moderator, get the files that community members flagged.
/connect/communities/communityId/​files/fileId/moderation-flags GET, POST, DELETE If the context user is a community moderator, get the number of times community members flagged a file. Also flag a file for moderation and delete all flags on a file.

If the context user isn’t a community moderator, get whether the user flagged a file. Also flag a file for moderation and remove a flag the user previously added.
/connect/communities/communityId/​chatter/feeds/moderation/feed-elements GET If the context user is a community moderator with the “Moderate Communities Feeds” permission, returns a list of all feed elements and comments in the community that have been flagged by community members. By default, returns 25 feed elements per page of results.
/connect/communities/communityId/​chatter/feeds/home/feed-elements GET Returns a list of all feed elements associated with any managed topic in the community.
/connect/communities/communityId/​managed-topics GET, POST, PATCH Get all the managed topics for a community. Create a managed topic, create managed topic hierarchies, and reorder managed topics.
/connect/communities/communityId/​managed-topics/managedTopicId GET, DELETE Get information about or delete a managed topic in a community.
/connect/communities/communityId/​trending-articles GET Get trending articles for a community.
/connect/communities/communityId/​topics/topicId/trending-articles GET Get trending articles for a topic in a community.
/connect/communities/communityId/​chatter/users/userId/reputation GET Returns the specified community user's reputation.