GEgetstream
product:chat

Update channel

Changed on

Change channel data

Sends events:

  • channel.updated
  • member.added
  • member.removed
  • member.updated
  • message.new
post/channels/{type}/{id}

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/channels/{type}/{id}
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Path parameters

typestring required
idstring required

Request body

accept_inviteboolean

Set to true to accept the invite

add_filter_tagsstring[]

List of filter tags to add to the channel

add_moderatorsstring[]

List of user IDs to make channel moderators

cooldowninteger

Sets cool down period for the channel in seconds

demote_moderatorsstring[]

List of user IDs to take away moderators status from

hide_historyboolean

Set to true to hide channel's history when adding new members

hide_history_beforestring date-time

If set, hides channel's history before this time when adding new members. Takes precedence over hide_history when both are provided. Must be in RFC3339 format (e.g., "2024-01-01T10:00:00Z") and in the past.

reject_inviteboolean

Set to true to reject the invite

remove_filter_tagsstring[]

List of filter tags to remove from the channel

remove_membersstring[]

List of user IDs to remove from the channel

skip_pushboolean

When message is set disables all push notifications for it

user_idstring

Response

Successful response

durationstring required

Duration of the request in milliseconds

Changes

  • 00df5052235bRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 8acf79c23a74Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status