Reports a message considered suspicious, harassing, inappropriate, or spam.
The following table lists the parameters that this action supports.
Required
Parameter name | Type | Description |
---|---|---|
channel_type | string | Specifies the type of channel. Acceptable values are open_channels and group_channels. |
channel_url | string | Specifies the URL of a channel. |
message_id | string | Specifies the unique ID of the message. |
The following table lists the properties of an HTTP request that this action supports.
Properties
Required | Type | Description |
---|---|---|
report_category | string | Specifies the category which indicates the reason for reporting. Acceptable values are suspicious, harassing, inappropriate, and spam. |
offending_user_id | string | Specifies the unique ID of a user who has sent an offensive message. |
Optional | Type | Description |
---|---|---|
reporting_user_id | string | Specifies the unique ID of the user who reports a message. |
report_description | string | Specifies additional information to include in the report. |
If successful, this action returns a report resource on the message in the response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.