Based on the profanity filter, this feature moderates users who are sending profanity words to a channel. You can apply profanity-triggered moderation as a global application setting or only to channels with a custom type. You can also adjust the level of the moderation by configuring the number of violation limit, the time window for counting violations, and the type of moderation penalty.
The following table lists the parameters that this action supports.
Specifies the custom channel type to apply a set of settings to a channel.
The following table lists the properties of an HTTP request that this action supports.
Specifies a moderation configuration to impose a penalty on users who reach the profanity violation limit within a channel.
Specifies the number of profanity violations that would automatically impose a penalty on the user. A value of
Specifies the time period in seconds. This time frame is used to count the number of violations a user commits within a channel. For example, if the value of the
Specifies the type of moderation penalty. The penalty is imposed permanently unless you cancel it. Acceptable values are the following:
If you want to turn off the profanity-triggered moderation, send a
PUT request with a value of the
count property set to 0 as shown below:
In the case of an error, an error object is returned. A detailed list of error codes is available here.