SEsendbird
Moderation

Freeze an open channel

Changed on

Freeze an open channel

Freezes or unfreezes an open channel.

Note: To learn more about other available moderation tools, see Moderation Overview.

https://sendbird.com/docs/chat/platform-api/v3/moderation/freezing-a-channel/freeze-an-open-channel#1-freeze-an-open-channel

put/v3/open_channels/{channel_url}/freeze

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Path parameters

channel_urlstring required

(Required)

Headers

api-tokenstring
Example:{{API_TOKEN}}

Request body

freezeboolean required

Determines whether to freeze the channel. (Default: true)

Response

Successful response

channel_urlstring required
cover_urlstring
created_atinteger
custom_typestring
datastring
freezeboolean
is_dynamic_partitionedboolean
is_ephemeralboolean
max_length_messageinteger
namestring
participant_countinteger
metadataobject nullable

Example response

{
  "cover_url": "cover_url",
  "metadata": "{}",
  "data": "data",
  "custom_type": "custom_type",
  "is_ephemeral": true,
  "created_at": 0,
  "is_dynamic_partitioned": true,
  "channel_url": "channel_url",
  "freeze": true,
  "participant_count": 1,
  "operators": [
    {
      "metadata": "{}",
      "require_auth_for_profile_image": true,
      "is_active": true,
      "role": "",
      "user_id": "user_id",
      "profile_url": "profile_url",
      "nickname": "nickname",
      "is_blocked_by_me": true
    },
    {
      "metadata": "{}",
      "require_auth_for_profile_image": true,
      "is_active": true,
      "role": "",
      "user_id": "user_id",
      "profile_url": "profile_url",
      "nickname": "nickname",
      "is_blocked_by_me": true
    }
  ],
  "max_length_message": 6,
  "name": "name"
}

Changes

  • 7a85bad03e90Revision changes
    • warning

      deleted the header request parameter Api-Token

    • warning

      removed the request property

    • info

      api operation id ocFreezeChannel removed and replaced with freezeAnOpenChannel

    • info

      added the new optional header request parameter api-token

  • 135d8b0705d4Revision changes
    • info

      the header request parameter Api-Token became optional