Update Rule

Update Rule

curl --request PUT \
  --url https://{appid}.api-{region}.cometchat.io/v3/moderation/rules/{ruleId} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "id": "moderation-test",
  "name": "Video Moderation",
  "enabled": true,
  "description": "AI-powered video moderation to detect unsafe content.",
  "action": [
    "blockMessage"
  ],
  "filters": [
    {
      "type": "sender",
      "entity": "user",
      "operand": "uid",
      "operator": "equals",
      "value": "admin"
    }
  ],
  "conditions": [
    {
      "id": 1,
      "entity": "message",
      "operand": "image",
      "operator": "contains",
      "category": "word",
      "isKeywordReferencePresent": false,
      "isMediaPresent": true,
      "value": "violence_greaterThan_30"
    }
  ]
}
'

{
  "data": {
    "id": "moderation-test",
    "name": "Video Moderation",
    "description": "AI-powered video moderation to detect unsafe content.",
    "enabled": true,
    "conditions": [
      {
        "id": 1,
        "isKeywordsReferencePresent": false,
        "isMediaPresent": true,
        "entity": "message",
        "operand": "image",
        "category": "word",
        "operator": "contains",
        "value": [
          "violence_greaterThan_30"
        ],
        "message": [
          "Image contains violence with confidence greater than 30"
        ]
      }
    ],
    "action": [
      "blockMessage"
    ],
    "active": true,
    "createdAt": 1720003247,
    "updatedAt": 1720003247,
    "revisionId": "253179cf5f665257_moderation-test_1"
  }
}

PUT

moderation

rules

{ruleId}

Update Rule

curl --request PUT \
  --url https://{appid}.api-{region}.cometchat.io/v3/moderation/rules/{ruleId} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "id": "moderation-test",
  "name": "Video Moderation",
  "enabled": true,
  "description": "AI-powered video moderation to detect unsafe content.",
  "action": [
    "blockMessage"
  ],
  "filters": [
    {
      "type": "sender",
      "entity": "user",
      "operand": "uid",
      "operator": "equals",
      "value": "admin"
    }
  ],
  "conditions": [
    {
      "id": 1,
      "entity": "message",
      "operand": "image",
      "operator": "contains",
      "category": "word",
      "isKeywordReferencePresent": false,
      "isMediaPresent": true,
      "value": "violence_greaterThan_30"
    }
  ]
}
'

{
  "data": {
    "id": "moderation-test",
    "name": "Video Moderation",
    "description": "AI-powered video moderation to detect unsafe content.",
    "enabled": true,
    "conditions": [
      {
        "id": 1,
        "isKeywordsReferencePresent": false,
        "isMediaPresent": true,
        "entity": "message",
        "operand": "image",
        "category": "word",
        "operator": "contains",
        "value": [
          "violence_greaterThan_30"
        ],
        "message": [
          "Image contains violence with confidence greater than 30"
        ]
      }
    ],
    "action": [
      "blockMessage"
    ],
    "active": true,
    "createdAt": 1720003247,
    "updatedAt": 1720003247,
    "revisionId": "253179cf5f665257_moderation-test_1"
  }
}

Authorizations

apikey

string

header

required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Path Parameters

ruleId

string

required

Rule ID

Body

application/json

string

Unique identifier for the moderation rule.

Example:

"moderation-test"

name

string

Descriptive name for the moderation rule.

Example:

"Video Moderation"

enabled

boolean

Indicates whether the rule is active.

Example:

true

description

string

Detailed explanation of the rule's purpose.

Example:

"AI-powered video moderation to detect unsafe content."

action

string[]

Actions to be taken when a violation is detected.

filters

object[]

List of filters to apply

Option 1
Option 2

Show child attributes

filters.type

enum<string>

required

Type of the filter, specifying sender or receiver

Available options:

sender,

receiver

Example:

"sender"

filters.entity

enum<string>

required

Type of entity for user filter

Available options:

user

filters.operand

enum<string>

required

Field to apply the filter on for 'user'

Available options:

uid,

name,

role,

tags,

createdAt

filters.operator

enum<string>

required

Operator to use for filtering

Available options:

equals,

not equals,

in,

not in,

startsWith

Example:

"equals"

filters.value

string

required

Value for the filter

Example:

"admin"

conditions

object[]

List of conditions that must be met for the rule to trigger.

Show child attributes

conditions.id

integer

Unique identifier of a condition

Example:

1

conditions.entity

string

Entity type in which moderation will be performed.

Example:

"message"

conditions.operand

enum<string>

Type of message content to moderate (e.g., text, image, video, custom).

Available options:

text,

image,

video,

custom

Example:

"image"

conditions.operator

enum<string>

Operation to be performed for condition evaluation (e.g., contains, equals).

Available options:

contains,

equals

Example:

"contains"

conditions.category

enum<string>

Type of entries for evaluation, either 'word' or 'pattern'.

Available options:

word,

pattern

Example:

"word"

conditions.isKeywordReferencePresent

boolean

Indicates if the value contains a reference to a keyword list.

Example:

false

conditions.isMediaPresent

boolean

Indicates if the incoming message contains media content.

Example:

true

conditions.value

string

Actual value for the condition, or reference ID if isKeywordReferencePresent is true, or a formula if isMediaPresent is true.

Example:

"violence_greaterThan_30"

Response

200 - application/json

Update Rule

data

object

Show child attributes

data.

object

Response data

Show child attributes

string

name

string

webhookURL

string

useBasicAuth

boolean

username

string

password

string

enabled

boolean

createdAt

integer

updatedAt

integer

Get Rule

Remove rule

⌘I

Chat APIs

Data Import APIs

Management APIs (Multi-Tenancy)

Authorizations

Path Parameters

Body

Response