Experience Cloud Sites Chatter Moderation Resources

Available resources are:

Moderation Flags on Comments

If the context user is a moderator, get the number of times members flagged a comment. Also flag a comment for moderation and delete all flags on a comment.

If the context user isn’t a moderator, returns whether the user flagged a comment. Also flag a comment for moderation and remove a flag the user previously added.

Resource

1/connect/communities/communityId/chatter/comments/commentId/moderation-flags

Available since release

29.0

Requires Chatter

Yes

HTTP methods

GET, DELETE, HEAD, POST

Request parameters for GET

Name	Type	Description	Required or Optional	Available Version
page	String	Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.	Optional	40.0
pageSize	Integer	Specifies the number of items per page. Valid values are from 1 through 100. The default size is 0.	Optional	40.0
visibility	String	Visibility behavior of a flag for various user types. ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged element or item. SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.	Optional	30.0

Request body for POST

Root XML tag

<moderationFlag>

JSON

1{ 
2   "note" : "Flagged by moderator as spam on 6.6.16.",
3   "type" : "FlagAsSpam",
4   "visibility" : "ModeratorsOnly"
5}

Properties

Name	Type	Description	Required or Optional	Available Version
note	String	A note of up to 4,000 characters about the flag.	Optional	38.0
type	String	Type of moderation flag. FlagAsInappropriate—Flag for inappropriate content. FlagAsSpam—Flag for spam.	Optional If not specified, FlagAs​Inappropriate is the default value.	38.0
visibility	String	Visibility behavior of a flag for various user types. ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged element or item. SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.	Optional	30.0

Request parameters for POST

Name	Type	Description	Required or Optional	Available Version
note	String	A note of up to 4,000 characters about the flag.	Optional	38.0
type	String	Type of moderation flag. FlagAsInappropriate—Flag for inappropriate content. FlagAsSpam—Flag for spam. If a type isn’t specified, it defaults to FlagAsInappropriate.	Optional If not specified, FlagAs​Inappropriate is the default value.	38.0
visibility	String	Visibility behavior of a flag for various user types. ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged element or item. SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.	Optional	30.0

Request parameters for DELETE

Name	Type	Description	Required or Optional	Available Version
userId	String	The ID of the context user. If specified, removes the flag the user previously added to the comment. If not specified and the context user is a moderator, removes all flags on the comment.	Optional	29.0

Response body for GET and POST

Moderation Flags