Chatter REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

Communities Moderation Resources

Information about whether a user has flagged a feed item, comment, or file as inappropriate. Also used to delete flags.

Available resources are:

Resource Description
/connect/communities​/communityId/​chatter/feed-items​/feedItemId/​moderation-flags If the logged-in user is a community moderator with the “Moderate Communities Feeds” permission, returns the number of times a post has been flagged by community members. Also flags a post for moderation and deletes all flags on a post.

If the logged-in user isn’t a community moderator, returns whether or not the user has flagged a post. Also flags a post for moderation and removes a flag the user previously added.
/connect/communities​/communityId/​chatter/comments​/commentId/​moderation-flags If the logged-in user is a community moderator, returns the number of times a comment has been flagged by community members. Also flags a comment for moderation and deletes all flags on a comment.

If the logged-in user isn’t a community moderator, returns whether or not the user has flagged a comment. Also flags a comment for moderation and removes a flag the user previously added.
/connect/communities/communityId/​chatter/files/moderation Files that are flagged in a community.

If the logged-in user is a community moderator, returns the files that have been flagged by community members.
/connect/communities/communityId/​chatter/files/fileId/moderation-flags If the logged-in user is a community moderator, returns the number of times a file has been flagged by community members. Also flags a file for moderation and deletes all flags on a file.

If the logged-in user isn’t a community moderator, returns whether or not the user has flagged a file. Also flags a file for moderation and removes a flag the user previously added.

Moderation Flags ​on Posts

If the logged-in user is a community moderator with the “Moderate Communities Feeds” permission, returns the number of times a post has been flagged by community members. Also flags a post for moderation and deletes all flags on a post.

If the logged-in user isn’t a community moderator, returns whether or not the user has flagged a post. Also flags a post for moderation and removes a flag the user previously added.

Resource
1/connect/communities/communityId/chatter/feed-items/feedItemId/moderation-flags
Available since release
29.0
HTTP methods
GET, DELETE, HEAD, POST
Request parameters for GET
Name Type Description Required or Optional Available Version
visibility String Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
 Optional 30.0
Request body for POST
Root XML tag
<moderationFlag>
JSON
1{ 
2   "visibility" : "ModeratorsOnly"
3}
Properties
Name Type Description Available Version
visibility String Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
 30.0
Request parameters for POST
Name Type Description Required or Optional Available Version
visibility String Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
 Optional 30.0
Request parameters for DELETE
Name Type Description Required or Optional Available Version
userId String The ID of the logged-in user. If specified, removes the flag the user previously added to the post. If not specified and the logged-in user is a moderator for the community, all flags on the post are removed. Optional 29.0
Response body for GET and POST
Moderation Flags

Moderation Flags​ on Comments

If the logged-in user is a community moderator, returns the number of times a comment has been flagged by community members. Also flags a comment for moderation and deletes all flags on a comment.

If the logged-in user isn’t a community moderator, returns whether or not the user has flagged a comment. Also flags a comment for moderation and removes a flag the user previously added.

Resource
1/connect/communities/communityId/chatter/comments/commentId/moderation-flags
Available since release
29.0
HTTP methods
GET, DELETE, HEAD, POST
Request parameters for GET
Name Type Description Required or Optional Available Version
visibility String Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
 Optional 30.0
Request body for POST
Root XML tag
<moderationFlag>
JSON
1{ 
2   "visibility" : "ModeratorsOnly"
3}
Properties
Name Type Description Available Version
visibility String Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
 30.0
Request parameters for POST
Name Type Description Required or Optional Available Version
visibility String Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
 Optional 30.0
Request parameters for DELETE
Name Type Description Required or Optional Available Version
userId String The ID of the logged-in user. If specified, removes the flag the user previously added to the comment. If not specified and the logged-in user is a moderator for the community, all flags on the comment are removed. Optional 29.0
Response body for GET and POST
Moderation Flags

Moderation Flags​ on Files

If the logged-in user is a community moderator, returns the number of times a file has been flagged by community members. Also flags a file for moderation and deletes all flags on a file.

If the logged-in user isn’t a community moderator, returns whether or not the user has flagged a file. Also flags a file for moderation and removes a flag the user previously added.

Resource
1/connect/communities/communityId/chatter/files/fileId/moderation-flags
Available since release
30.0
HTTP methods
GET, DELETE, HEAD, POST
Request parameters for GET
Name Type Description Required or Optional Available Version
visibility String Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
 Optional 30.0
Request body for POST
Root XML tag
<moderationFlag>
JSON
1{ 
2   "visibility" : "ModeratorsOnly"
3}
Properties
Name Type Description Available Version
visibility String Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
 30.0
Request parameters for POST
Name Type Description Required or Optional Available Version
visibility String Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
 Optional 30.0
Request parameters for DELETE
Name Type Description Required or Optional Available Version
userId String The ID of the logged-in user. If specified, removes the flag the user previously added to the file. If not specified and the logged-in user is a moderator for the community, all flags on the file are removed. Optional 30.0
Response body for GET and POST
Moderation Flags

Flagged Files

Files that are flagged in a community.

If the logged-in user is a community moderator, returns the files that have been flagged by community members.

Resource
1/connect/communities/communityId/chatter/files/moderation
Available since release
30.0
HTTP methods
GET, HEAD
Request parameters for GET
Name Type Description Required or Optional Available Version
page Integer Specifies the number of the page you want returned. Optional 30.0
pageSize Integer Specifies the number of items per page. Valid values are between 1 and 100. If you don't specify a size, the default is 25. Optional 30.0
Response body
File Summary