Open channel

Update an open channel

Changed on

Update an open channel

You can update information about an open channel using this API. You can add a cover image to a channel to better identify the channel or specify a custom channel type for grouping channels by custom type. See this page to learn more about channel types.

https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/update-an-open-channel#1-update-an-open-channel

put/v3/open_channels/{channel_url}

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

cover_filestring binary
cover_urlstring
custom_typestring
datastring
namestring
operator_idsstring[]

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

    • warning

      deleted the header request parameter Api-Token

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      api operation id ocUpdateChannelByUrl removed and replaced with updateAnOpenChannel

    • info

      added the new optional header request parameter api-token

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional