POST /messages/{message_id}/report

Sends a notification to the organization's moderation request channel, if it is configured, that reports the targeted message for review and moderation.

Clients should check the moderation_request_channel realm setting to decide whether to show the option to report messages in the UI.

If the report_type parameter value is "other", the description parameter is required. Clients should also enforce and communicate this behavior in the UI.

Changes: New in Zulip 11.0 (feature level 382). This API builds on the moderation_request_channel realm setting, which was added in feature level 331.

Servers

https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1

Path parameters

Name	Type	Required	Description
`message_id`	Integer	Yes	The target message's ID.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description

Name	Type	Required	Description
`report_type`	String	Yes	The reason that best describes why the current user is reporting the target message for moderation. Must be one of the `key` values in the `server_report_message_types` field in the `POST /register` response. Changes: Prior to Zulip 12.0 (feature level 435), the allowed values for this parameter were limited to: `"harassment"`, `"inappropriate"`, `"norms"`, `"other"`, `"spam"`.
`description`	String	No	A short description with additional context about why the current user is reporting the target message for moderation. Clients should limit this string to 1000 Unicode code points. If the `report_type` parameter is `"other"`, this parameter is required, and its value cannot be an empty string.

report_type

String

Yes

The reason that best describes why the current user is reporting the target message for moderation.

Must be one of the key values in the server_report_message_types field in the POST /register response.

Changes: Prior to Zulip 12.0 (feature level 435), the allowed values for this parameter were limited to: "harassment", "inappropriate", "norms", "other", "spam".

description

String

A short description with additional context about why the current user is reporting the target message for moderation.

Clients should limit this string to 1000 Unicode code points.

If the report_type parameter is "other", this parameter is required, and its value cannot be an empty string.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.