Sign in
Chat channels

Retrieve chat channel

Retrieves the details of an existing chat channel.

Required permissions:

  • chat:read
get/chat_channels/{id}

Path parameters

idstring required

The unique identifier of the chat channel or experience to retrieve.

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

No changes recorded. 1 of the 74 revisions has no diff computed, so it could not be searched.