Returns the configuration for content flagging, including the list of available reasons for flagging content. This data is used to gather details from the user when they flag content.
description:The reason for flagging the post. This must be one of the configured reasons available for selection.
comment:
type:string
description:Comment from the user flagging the post.
responses:
"200":
description:Post flagged successfully
content:
application/json:
schema:
$ref:"#/components/schemas/StatusOK"
'400':
description:Bad request - Invalid input data or missing required fields.
'403':
description:Forbidden - User does not have permission to flag this post.
'404':
description:Post not found or feature is disabled via the feature flag.
'500':
description:Internal server error.
'501':
description:Feature is disabled either via config or an Enterprise Advanced license is not available.
/api/v4/content_flagging/fields:
get:
summary:Get content flagging property fields
description:|
Returns the list of property fields that can be associated with content flagging reports. These fields are used for storing metadata about a post's flag.
summary:Get content flagging property field values for a post
description:|
Returns the property field values associated with content flagging reports for a specific post. These values provide additional context about the flags on the post.
An enterprise advanced license is required.
tags:
- Content Flagging
parameters:
- in:path
name:post_id
required:true
schema:
type:string
description:The ID of the post to retrieve property field values for
description:Property field values retrieved successfully
content:
application/json:
schema:
type:array
items:
$ref:"#/components/schemas/PropertyValue"
description:An array of property field values associated with the post
'403':
description:Forbidden - User does not have permission to access this post.
'404':
description:Post not found or feature is disabled via the feature flag.
'500':
description:Internal server error.
'501':
description:Feature is disabled either via config or an Enterprise Advanced license is not available.
/api/v4/content_flagging/post/{post_id}:
get:
summary:Get a flagged post with all its content.
description:|
Returns the flagged post with all its data, even if it is soft-deleted. This endpoint is only accessible by content reviewers. A content reviewer can only fetch flagged posts from this API if the post is indeed flagged and they are a content reviewer of the post's team.
description:Forbidden - User does not have permission to access this post, or is not a reviewer of the post's team.
'404':
description:Post not found or feature is disabled via the feature flag.
'500':
description:Internal server error.
'501':
description:Feature is disabled either via config or an Enterprise Advanced license is not available.
/api/v4/content_flagging/post/{post_id}/remove:
put:
summary:Remove a flagged post
description:|
Permanently removes a flagged post and all its associated contents from the system. This action is typically performed by content reviewers after they have reviewed the flagged content. This action is irreversible.
The user must be a content reviewer of the team to which the post belongs to.
description:Forbidden - User does not have permission to remove this post.
'404':
description:Post not found or feature is disabled via the feature flag.
'500':
description:Internal server error.
'501':
description:Feature is disabled either via config or an Enterprise Advanced license is not available.
/api/v4/content_flagging/post/{post_id}/keep:
put:
summary:Keep a flagged post
description:|
Marks a flagged post as reviewed and keeps it in the system without any changes. This action is typically performed by content reviewers after they have reviewed the flagged content and determined that it does not violate any guidelines.
The user must be a content reviewer of the team to which the post belongs to.
summary:Generate and download a flagged post report
description:|
Generates a ZIP archive containing the flagged post, its edit history, content review details, post metadata, and any associated file attachments, then streams the archive back to the caller as a download. All other content reviewers of the post's team are notified that a report has been generated.
The user must be a content reviewer of the team to which the post belongs to, and the post must be flagged.
An enterprise advanced license is required.
tags:
- Content Flagging
parameters:
- in:path
name:post_id
required:true
schema:
type:string
description:The ID of the flagged post to generate the report for
operationId:GenerateCFPostReport
requestBody:
required:false
content:
application/json:
schema:
type:object
properties:
comment:
type:string
description:Optional comment from the reviewer to be included in the generated report.
responses:
'200':
description:Report generated successfully. The response body is a ZIP archive containing the flagged post report.
headers:
Content-Disposition:
schema:
type:string
description:Specifies the suggested filename for the downloaded archive (e.g. `attachment; filename="flagged-post-{post_id}-{timestamp}.zip"`).
content:
application/zip:
schema:
type:string
format:binary
'400':
description:Bad request - Invalid post ID.
'403':
description:Forbidden - User does not have permission to access this post, or is not a reviewer of the post's team.
'404':
description:Post not found or post is not flagged.
'500':
description:Internal server error.
'501':
description:Feature is disabled either via config or an Enterprise Advanced license is not available.
