Report a user
Reports a user who sends an offensive message in a channel.
HTTP request
Parameters
The following table lists the parameters that this action supports.
Required
Parameter name | Type | Description |
---|---|---|
offending_user_id | string | Specifies the unique ID of a user who has sent an offensive message. |
Request body
The following table lists the properties of an HTTP request that this action supports.
Properties
Required | Type | Description |
---|---|---|
channel_type | string | Specifies the type of channel. Acceptable values are |
channel_url | string | Specifies the URL of a channel. |
report_category | string | Specifies the category which indicates the reason for reporting. Acceptable values are |
Optional | Type | Description |
---|---|---|
reporting_user_id | string | Specifies the unique ID of the user who reports another user. |
report_description | string | Specifies additional information to include in the report. |
custom_report_category_name | string | Specifies the name of the custom report category. Maximum length is 50 characters. |
Response
If successful, this action returns a report resource on the user in the response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.