Sign in
Chat channels

Update chat channel

Update moderation settings for a chat channel, such as who can post, banned words, and media restrictions.

Required permissions:

  • chat:moderate
patch/chat_channels/{id}

Path parameters

idstring required

The unique identifier of the chat channel to update. Accepts either an experience ID (e.g. 'exp_xxxxx') or a chat channel ID.

Request body

ban_mediaboolean nullable

Whether media uploads such as images and videos are banned in this chat channel.

ban_urlsboolean nullable

Whether URLs and links are banned from being posted in this chat channel.

banned_wordsstring[] nullable

A list of words that are automatically blocked from messages in this chat channel. For example, ['spam', 'scam'].

user_posts_cooldown_secondsinteger nullable

The minimum number of seconds a user must wait between sending messages in this chat channel. Pass null or 0 to remove the cooldown.

who_can_post'everyone' | 'admins'

Who can post on a chat feed

who_can_react'everyone' | 'no_one'

Who can react on a chat feed

Example request

{
  "user_posts_cooldown_seconds": 42
}

Response

A successful response

ban_mediaboolean required

Whether media uploads such as images and videos are blocked in this chat.

ban_urlsboolean required

Whether URL links are blocked from being posted in this chat.

banned_wordsstring[] required

A list of words that are automatically filtered from messages in this chat. Empty unless the caller has permission to moderate this chat.

idstring required

The unique identifier for the entity

user_posts_cooldown_secondsinteger nullable required

The minimum number of seconds a user must wait between consecutive messages. Null if no cooldown is enforced.

who_can_post'everyone' | 'admins' required

Who can post on a chat feed

who_can_react'everyone' | 'no_one' required

Who can react on a chat feed

Example response

{
  "experience": {
    "id": "exp_xxxxxxxxxxxxxx",
    "name": "Trading Signals Chat"
  },
  "user_posts_cooldown_seconds": 42
}

Changes